- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.
HTTP request
POST https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project |
Project ID for this request. |
region |
Name of the region scoping this request. |
security |
Name of the security policy to update. |
Query parameters
| Parameters | |
|---|---|
priority |
The priority of the rule to patch. |
validate |
If true, the request will not be committed. |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "kind": string, "description": string, "priority": integer, "match": { "expr": { "expression": string, "title": string, "description": string, "location": string }, "exprOptions": { "recaptchaOptions": { "actionTokenSiteKeys": [ string ], "sessionTokenSiteKeys": [ string ] } }, "versionedExpr": enum, "config": { "srcIpRanges": [ string ], "destIpRanges": [ string ], "layer4Configs": [ { "ipProtocol": string, "ports": [ string ] } ] } }, "networkMatch": { "userDefinedFields": [ { "name": string, "values": [ string ] } ], "srcIpRanges": [ string ], "destIpRanges": [ string ], "ipProtocols": [ string ], "srcPorts": [ string ], "destPorts": [ string ], "srcRegionCodes": [ string ], "srcAsns": [ integer ] }, "action": string, "preview": boolean, "direction": enum, "targetResources": [ string ], "enableLogging": boolean, "ruleTupleCount": integer, "rateLimitOptions": { "rateLimitThreshold": { "count": integer, "intervalSec": integer }, "conformAction": string, "exceedAction": string, "exceedRedirectOptions": { "type": enum, "target": string }, "enforceOnKey": enum, "enforceOnKeyName": string, "enforceOnKeyConfigs": [ { "enforceOnKeyType": enum, "enforceOnKeyName": string } ], "banThreshold": { "count": integer, "intervalSec": integer }, "banDurationSec": integer }, "targetServiceAccounts": [ string ], "ruleNumber": string, "headerAction": { "requestHeadersToAdds": [ { "headerName": string, "headerValue": string } ] }, "redirectOptions": { "type": enum, "target": string }, "preconfiguredWafConfig": { "exclusions": [ { "targetRuleSet": string, "targetRuleIds": [ string ], "requestHeadersToExclude": [ { "val": string, "op": enum } ], "requestCookiesToExclude": [ { "val": string, "op": enum } ], "requestQueryParamsToExclude": [ { "val": string, "op": enum } ], "requestUrisToExclude": [ { "val": string, "op": enum } ] } ] } } |
| Fields | |
|---|---|
kind |
[Output only] Type of the resource. Always |
description |
An optional description of this resource. Provide this property when you create the resource. |
priority |
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. |
match |
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. |
match. |
User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing |
match. |
Textual representation of an expression in Common Expression Language syntax. |
match. |
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. |
match. |
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
match. |
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
match. |
The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr'). |
match. |
reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect. |
match. |
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. |
match. |
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. |
match. |
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 srcIpRange field in config. |
match. |
The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified. |
match. |
CIDR IP address range. Maximum number of srcIpRanges allowed is 10. |
match.config.destIpRanges[] |
CIDR IP address range. This field may only be specified when versionedExpr is set to FIREWALL. |
match.config.layer4Configs[] |
Pairs of IP protocols and ports that the rule should match. This field may only be specified when versionedExpr is set to FIREWALL. |
match.config.layer4Configs[] |
The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings ( |
match.config.layer4Configs[] |
An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: This field may only be specified when versionedExpr is set to FIREWALL. |
network |
A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive. |
network |
User-defined fields. Each element names a defined field and lists the matching values for that field. |
network |
Name of the user-defined field, as given in the definition. |
network |
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"). |
network |
Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format. |
network |
Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format. |
network |
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". |
network |
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"). |
network |
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"). |
network |
Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address. |
network |
BGP Autonomous System Number associated with the source IP address. |
action |
The Action to perform when the rule is matched. The following are the valid actions:
|
preview |
If set to true, the specified action is not enforced. |
direction |
The direction in which this rule applies. This field may only be specified when versionedExpr is set to FIREWALL. |
targetResources[] |
A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versionedExpr is set to FIREWALL. |
enableLogging |
Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. This field may only be specified when the versionedExpr is set to FIREWALL. |
ruleTupleCount |
[Output Only] Calculation of the complexity of a single firewall security policy rule. |
rate |
Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions. |
rate |
Threshold at which to begin ratelimiting. |
rate |
Number of HTTP(S) requests for calculating the threshold. |
rate |
Interval over which the threshold is computed. |
rate |
Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only. |
rate |
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 |
rate |
Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR. |
rate |
Type of the redirect action. |
rate |
Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. |
rate |
Determines the key to enforce the rateLimitThreshold on. Possible values are:
|
rate |
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. |
rate |
If specified, any combination of values of enforceOnKeyType/enforceOnKeyName is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforceOnKeyConfigs. If enforceOnKeyConfigs is specified, enforceOnKey must not be specified. |
rate |
Determines the key to enforce the rateLimitThreshold on. Possible values are:
|
rate |
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. |
rate |
Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'banDurationSec' when the number of requests that exceed the 'rateLimitThreshold' also exceed this 'banThreshold'. |
rate |
Number of HTTP(S) requests for calculating the threshold. |
rate |
Interval over which the threshold is computed. |
rate |
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. |
targetServiceAccounts[] |
A list of service accounts indicating the sets of instances that are applied with this rule. |
rule |
Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server. |
header |
Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR. |
header |
The list of request headers to add or overwrite if they're already present. |
header |
The name of the header to set. |
header |
The value to set the named header to. |
redirect |
Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR. |
redirect |
Type of the redirect action. |
redirect |
Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA. |
preconfigured |
Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect. |
preconfigured |
A list of exclusions to apply during preconfigured WAF evaluation. |
preconfigured |
Target WAF rule set to apply the preconfigured WAF exclusion. |
preconfigured |
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. |
preconfigured |
A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation. |
preconfigured |
The value of the field. |
preconfigured |
The match operator for the field. |
preconfigured |
A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation. |
preconfigured |
The value of the field. |
preconfigured |
The match operator for the field. |
preconfigured |
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. |
preconfigured |
The value of the field. |
preconfigured |
The match operator for the field. |
preconfigured |
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. |
preconfigured |
The value of the field. |
preconfigured |
The match operator for the field. |
Response body
Represents an Operation resource.
Google Compute Engine has three Operation resources:
You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
Operations can be global, regional or zonal.
- For global operations, use the
globalOperationsresource. - For regional operations, use the
regionOperationsresource. - For zonal operations, use the
zoneOperationsresource.
For more information, read Global, Regional, and Zonal Resources.
Note that completed Operation resources have a limited retention period.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": integer, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } } ] } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "operationGroupId": string, // Union field |
| Fields | |
|---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the operation. This identifier is defined by the server. |
creation |
[Deprecated] This field is deprecated. |
name |
[Output Only] Name of the operation. |
zone |
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
client |
[Output Only] The value of |
operation |
[Output Only] The type of operation, such as |
target |
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. |
target |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
status |
[Output Only] The status of the operation, which can be one of the following: |
status |
[Output Only] An optional textual description of the current status of the operation. |
user |
[Output Only] User who requested the operation, for example: |
progress |
[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. |
insert |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
start |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
end |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
error |
[Output Only] If errors are generated during processing of the operation, this field will be populated. |
error. |
[Output Only] The array of errors encountered while processing this operation. |
error. |
[Output Only] The error type identifier for this error. |
error. |
[Output Only] Indicates the field in the request that caused the error. This property is optional. |
error. |
[Output Only] An optional, human-readable error message. |
error. |
[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. |
error. |
|
error. |
The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of |
error. |
The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". |
error. |
Additional structured details about this error. Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request. |
error. |
|
error. |
The Compute Engine quota metric name. |
error. |
The name of the quota limit. |
error. |
The map holding related quota dimensions. |
error. |
Current effective quota limit. The limit's unit depends on the quota type or metric. |
error. |
Future quota limit being rolled out. The limit's unit depends on the quota type or metric. |
error. |
Rollout status of the future quota limit. |
error. |
|
error. |
URL(s) pointing to additional information on handling the current error. |
error. |
Describes what the link offers. |
error. |
The URL of the link. |
error. |
|
error. |
The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" |
error. |
The localized error message in the above locale. |
warnings[] |
[Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
warnings[]. |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warnings[]. |
[Output Only] A human-readable description of the warning code. |
warnings[]. |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warnings[]. |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
warnings[]. |
[Output Only] A warning data value corresponding to the key. |
http |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
http |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as |
self |
[Output Only] Server-defined URL for the resource. |
region |
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
description |
[Output Only] A textual description of the operation, which is set when the operation is created. |
operation |
[Output Only] An ID that represents a group of operations, such as when a group of operations results from a |
Union field metadata. [Output Only] Service-specific metadata attached to this operation. metadata can be only one of the following: |
|
set |
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. |
set |
[Output Only] The client operation id. |
set |
[Output Only] Status information per location (location name is key). Example key: zones/us-central1-a |
set |
[Output Only] Status of the action, which can be one of the following: |
set |
[Output Only] If state is |
set |
The status code, which should be an enum value of |
set |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
set |
A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field |
instances |
|
instances |
Status information per location (location name is key). Example key: zones/us-central1-a |
instances |
[Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. |
instances |
[Output Only] Count of VMs originally planned to be created. |
instances |
[Output Only] Count of VMs successfully created so far. |
instances |
[Output Only] Count of VMs that started creating but encountered an error. |
instances |
[Output Only] Count of VMs that got deleted during rollback. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/computehttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.regionSecurityPolicies.update
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.