Reference documentation and code samples for the Compute Engine v1 API enum SecurityPolicyRuleRateLimitOptions.Types.EnforceOnKey.
Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-08 UTC."],[[["\u003cp\u003eThis document provides versioned reference documentation for the \u003ccode\u003eEnforceOnKey\u003c/code\u003e enum within the \u003ccode\u003eGoogle.Cloud.Compute.V1.SecurityPolicyRuleRateLimitOptions.Types\u003c/code\u003e namespace, spanning versions from 1.0.0 to 3.6.0 (latest).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEnforceOnKey\u003c/code\u003e enum defines the various keys that can be used to enforce rate limits, including options like \u003ccode\u003eALL\u003c/code\u003e, \u003ccode\u003eIP\u003c/code\u003e, \u003ccode\u003eHTTP_HEADER\u003c/code\u003e, \u003ccode\u003eXFF_IP\u003c/code\u003e, \u003ccode\u003eHTTP_COOKIE\u003c/code\u003e, \u003ccode\u003eHTTP_PATH\u003c/code\u003e, \u003ccode\u003eSNI\u003c/code\u003e, \u003ccode\u003eREGION_CODE\u003c/code\u003e, \u003ccode\u003eTLS_JA3_FINGERPRINT\u003c/code\u003e, and \u003ccode\u003eUSER_IP\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation specifies the default behavior for \u003ccode\u003eEnforceOnKey\u003c/code\u003e when a certain key type is not present, such as defaulting to \u003ccode\u003eALL\u003c/code\u003e if a specified HTTP header or cookie is missing, or falling back to \u003ccode\u003eIP\u003c/code\u003e if the X-Forwarded-For header cannot be resolved.\u003c/p\u003e\n"],["\u003cp\u003eThe current \u003ccode\u003eEnforceOnKey\u003c/code\u003e enum includes fields such as \u003ccode\u003eAll\u003c/code\u003e, \u003ccode\u003eHttpCookie\u003c/code\u003e, \u003ccode\u003eHttpHeader\u003c/code\u003e, \u003ccode\u003eHttpPath\u003c/code\u003e, \u003ccode\u003eIp\u003c/code\u003e, \u003ccode\u003eRegionCode\u003c/code\u003e, \u003ccode\u003eSni\u003c/code\u003e, \u003ccode\u003eTlsJa3Fingerprint\u003c/code\u003e, \u003ccode\u003eUndefinedEnforceOnKey\u003c/code\u003e, \u003ccode\u003eUserIp\u003c/code\u003e and \u003ccode\u003eXffIp\u003c/code\u003e, each corresponding to a different key type.\u003c/p\u003e\n"]]],[],null,[]]
