request_​client_​hints

Version: v2025-01-13Includes use: Yes

Behavior name: Request Client Hints

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.

Use requestClientHints together with the permissions_policy behavior.

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "request_client_hints" {
  rules_v2025_02_18 {
    name     = "Request Client Hints"
    comments = "configures and prioritizes the client hints you want to send to request specific client and device information."
    behavior {
      request_client_hints {
        accept_critical_ch = []
        accept_ch = []
        reset = false
      }
    }
  }
}
"behaviors": [
  {
    "name": "requestClientHints",
    "options": {
      "acceptCh": [],
      "acceptCriticalCh": [],
      "reset": false
    }
  }
]

Options

Option Description
accept_ch
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. Possible values are:
  • Device-Memory
  • Downlink
  • ECT
  • RTT
  • Sec-CH-DPR
  • Sec-CH-UA
  • Sec-CH-UA-Arch
  • Sec-CH-UA-Bitness
  • Sec-CH-UA-Full-Version-List
  • Sec-CH-UA-Mobile
  • Sec-CH-UA-Model
  • Sec-CH-UA-Platform
  • Sec-CH-UA-Platform-Version
  • Sec-CH-Viewport-Width
  • Sec-CH-Width
accept_critical_ch
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. Possible values are:
  • Device-Memory
  • Downlink
  • ECT
  • RTT
  • Sec-CH-DPR
  • Sec-CH-UA
  • Sec-CH-UA-Arch
  • Sec-CH-UA-Bitness
  • Sec-CH-UA-Full-Version-List
  • Sec-CH-UA-Mobile
  • Sec-CH-UA-Model
  • Sec-CH-UA-Platform
  • Sec-CH-UA-Platform-Version
  • Sec-CH-Viewport-Width
  • Sec-CH-Width
reset
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. To enable this option, leave accept_ch and accept_critical_ch empty.