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.
[[["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\u003c/code\u003e namespace, detailing its use in \u003ccode\u003eSecurityPolicyRuleRateLimitOptions\u003c/code\u003e with versions ranging from 1.0.0 to 3.6.0, the latest version.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEnforceOnKey\u003c/code\u003e enum specifies different key types that determine how rate limits are enforced, including options such as \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, and \u003ccode\u003eREGION_CODE\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version for the \u003ccode\u003eEnforceOnKey\u003c/code\u003e enum documentation is version 3.6.0, but there are other versions available for usage down to version 1.0.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eUndefinedEnforceOnKey\u003c/code\u003e field indicates when the enum field is not set, providing a designated value to signify an unset state.\u003c/p\u003e\n"]]],[],null,[]]
