--- title: "POST /locations/global/securityPolicies/{securityPolicy}/patchRule" method: POST path: "/locations/global/securityPolicies/{securityPolicy}/patchRule" tags: ["organizationSecurityPolicies"] --- # POST /locations/global/securityPolicies/{securityPolicy}/patchRule `POST /locations/global/securityPolicies/{securityPolicy}/patchRule` Patches a rule at the specified priority. Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.patchRule instead. ## Path parameters - `securityPolicy` string, required ## Query parameters - `priority` integer - `requestId` string ## Request body - SecurityPolicyRule — Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - `headerAction` SecurityPolicyRuleHttpHeaderAction - `requestHeadersToAdds` SecurityPolicyRuleHttpHeaderActionHttpHeaderOption[] — The list of request headers to add or overwrite if they're already present. - `headerValue` string — The value to set the named header to. - `headerName` string — The name of the header to set. - `kind` string — Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules - `match` SecurityPolicyRuleMatcher — Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. - `versionedExpr` 'SRC_IPS_V1' — Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. - `expr` Expr — Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. - `description` string — Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - `expression` string — Textual representation of an expression in Common Expression Language syntax. - `title` string — Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. - `location` string — Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - `exprOptions` SecurityPolicyRuleMatcherExprOptions - `recaptchaOptions` SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions - `actionTokenSiteKeys` string[] — A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created. - `sessionTokenSiteKeys` string[] — A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created. - `config` SecurityPolicyRuleMatcherConfig - `srcIpRanges` string[] — CIDR IP address range. Maximum number of src_ip_ranges allowed is 10. - `rateLimitOptions` SecurityPolicyRuleRateLimitOptions - `rateLimitThreshold` SecurityPolicyRuleRateLimitOptionsThreshold - `count` integer — Number of HTTP(S) requests for calculating the threshold. - `intervalSec` integer — Interval over which the threshold is computed. - `banDurationSec` integer — Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold. - `enforceOnKey` 'ALL' | 'HTTP_COOKIE' | 'HTTP_HEADER' | 'HTTP_PATH' | 'IP' | 'REGION_CODE' | 'SNI' | 'TLS_JA3_FINGERPRINT' | 'TLS_JA4_FINGERPRINT' | 'USER_IP' | 'XFF_IP' — 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 toALL. - 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 toALL. - 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 toIP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule. - `enforceOnKeyConfigs` SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig[] — If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified. - `enforceOnKeyType` 'ALL' | 'HTTP_COOKIE' | 'HTTP_HEADER' | 'HTTP_PATH' | 'IP' | 'REGION_CODE' | 'SNI' | 'TLS_JA3_FINGERPRINT' | 'TLS_JA4_FINGERPRINT' | 'USER_IP' | 'XFF_IP' — 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 "enforceOnKeyConfigs" 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 toALL. - 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 toALL. - 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 toIP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - `enforceOnKeyName` string — Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value. - `enforceOnKeyName` string — Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value. - `banThreshold` SecurityPolicyRuleRateLimitOptionsThreshold - `count` integer — Number of HTTP(S) requests for calculating the threshold. - `intervalSec` integer — Interval over which the threshold is computed. - `conformAction` string — Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only. - `exceedAction` string — Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR. - `exceedRedirectOptions` SecurityPolicyRuleRedirectOptions - `target` string — Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. - `type` 'EXTERNAL_302' | 'GOOGLE_RECAPTCHA' — Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response. - `preconfiguredWafConfig` SecurityPolicyRulePreconfiguredWafConfig - `exclusions` SecurityPolicyRulePreconfiguredWafConfigExclusion[] — A list of exclusions to apply during preconfigured WAF evaluation. - `targetRuleIds` string[] — A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set. - `requestCookiesToExclude` SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams[] — A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation. - `val` string — The value of the field. - `op` 'CONTAINS' | 'ENDS_WITH' | 'EQUALS' | 'EQUALS_ANY' | 'STARTS_WITH' — The match operator for the field. - `requestQueryParamsToExclude` SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams[] — A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body. - `val` string — The value of the field. - `op` 'CONTAINS' | 'ENDS_WITH' | 'EQUALS' | 'EQUALS_ANY' | 'STARTS_WITH' — The match operator for the field. - `targetRuleSet` string — Target WAF rule set to apply the preconfigured WAF exclusion. - `requestUrisToExclude` SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams[] — A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded. - `val` string — The value of the field. - `op` 'CONTAINS' | 'ENDS_WITH' | 'EQUALS' | 'EQUALS_ANY' | 'STARTS_WITH' — The match operator for the field. - `requestHeadersToExclude` SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams[] — A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation. - `val` string — The value of the field. - `op` 'CONTAINS' | 'ENDS_WITH' | 'EQUALS' | 'EQUALS_ANY' | 'STARTS_WITH' — The match operator for the field. - `priority` integer — An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. - `preview` boolean — If set to true, the specified action is not enforced. - `networkMatch` SecurityPolicyRuleNetworkMatcher — Represents a match condition that incoming network traffic is evaluated against. - `userDefinedFields` SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch[] — User-defined fields. Each element names a defined field and lists the matching values for that field. - `name` string — Name of the user-defined field, as given in the definition. - `values` string[] — Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff"). - `srcIpRanges` string[] — Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format. - `srcAsns` integer[] — BGP Autonomous System Number associated with the source IP address. - `ipProtocols` string[] — IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp". - `srcRegionCodes` string[] — Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address. - `destIpRanges` string[] — Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format. - `srcPorts` string[] — Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023"). - `destPorts` string[] — Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023"). - `description` string — An optional description of this resource. Provide this property when you create the resource. - `action` string — The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. - fairshare (preview only): when traffic reaches the threshold limit, requests from the clients matching this rule begin to be rate-limited using the Fair Share algorithm. This action is only allowed in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`. - `redirectOptions` SecurityPolicyRuleRedirectOptions - `target` string — Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. - `type` 'EXTERNAL_302' | 'GOOGLE_RECAPTCHA' — Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/compute.md) · [All operations](https://skmtc.net/google/apis/compute/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/compute/revisions/6120ed8969d4/schema)