--- title: "PATCH /projects/{project}/global/firewallPolicies/{firewallPolicy}" method: PATCH path: "/projects/{project}/global/firewallPolicies/{firewallPolicy}" tags: ["networkFirewallPolicies"] --- # PATCH /projects/{project}/global/firewallPolicies/{firewallPolicy} `PATCH /projects/{project}/global/firewallPolicies/{firewallPolicy}` Patches the specified policy with the data included in the request. ## Path parameters - `project` string, required - `firewallPolicy` string, required ## Query parameters - `requestId` string ## Request body - FirewallPolicy — Represents a Firewall Policy resource. - `id` string, uint64 — [Output Only] The unique identifier for the resource. This identifier is defined by the server. - `selfLinkWithId` string — Output only. [Output Only] Server-defined URL for this resource with the resource id. - `associations` FirewallPolicyAssociation[] — A list of associations that belong to this firewall policy. - `name` string — The name for an association. - `firewallPolicyId` string — Output only. [Output Only] The firewall policy ID of the association. - `attachmentTarget` string — The target that the firewall policy is attached to. - `shortName` string — Output only. [Output Only] The short name of the firewall policy of the association. - `displayName` string — [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. - `displayName` string — Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - `selfLink` string — [Output Only] Server-defined URL for the resource. - `ruleTupleCount` integer — Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. - `packetMirroringRules` FirewallPolicyRule[] — A list of packet mirroring rules that belong to this policy. - `disabled` boolean — Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - `tlsInspect` boolean — Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - `description` string — An optional description for this resource. - `action` string — The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next" ( "apply_security_profile_group" can be specified only for global network firewall policies or hierarchical firewall policies). Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". - `targetType` 'INSTANCES' | 'INTERNAL_MANAGED_LB' — Target types of the firewall policy rule. Default value is INSTANCES. - `direction` 'EGRESS' | 'INGRESS' — The direction in which this rule applies. - `targetServiceAccounts` string[] — A list of service accounts indicating the sets of instances that are applied with this rule. - `kind` string — Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules. - `targetSecureTags` FirewallPolicyRuleSecureTag[] — A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts. If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - `name` string — Name of the secure tag, created with TagManager's TagValue API. - `state` 'EFFECTIVE' | 'INEFFECTIVE' — Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - `ruleName` string — An optional name for the rule. This field is not a unique identifier and can be updated. - `targetForwardingRules` string[] — A list of forwarding rules to which this rule applies. This field allows you to control which load balancers get this rule. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - projects/project/global/ forwardingRules/forwardingRule - projects/project/regions/region/forwardingRules/ forwardingRule - `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. - `targetResources` string[] — 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. - `ruleTupleCount` integer — Output only. [Output Only] Calculation of the complexity of a single firewall policy rule. - `match` FirewallPolicyRuleMatcher — Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. - `srcIpRanges` string[] — CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - `destAddressGroups` string[] — Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - `srcAddressGroups` string[] — Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - `srcFqdns` string[] — Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - `destRegionCodes` string[] — Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - `srcNetworkContext` 'INTERNET' | 'INTRA_VPC' | 'NON_INTERNET' | 'UNSPECIFIED' | 'VPC_NETWORKS' — Network context of the traffic source. Allowed values are: - UNSPECIFIED - INTERNET - INTRA_VPC - NON_INTERNET - VPC_NETWORKS - `srcNetworkType` 'INTERNET' | 'INTRA_VPC' | 'NON_INTERNET' | 'UNSPECIFIED' | 'VPC_NETWORKS' — Network type of the traffic source. Allowed values are: - UNSPECIFIED - INTERNET - INTRA_VPC - NON_INTERNET - VPC_NETWORKS - `destNetworkType` 'INTERNET' | 'INTRA_VPC' | 'NON_INTERNET' | 'UNSPECIFIED' | 'VPC_NETWORKS' — Network type of the traffic destination. Allowed values are: - UNSPECIFIED - INTERNET - NON_INTERNET - `layer4Configs` FirewallPolicyRuleMatcherLayer4Config[] — Pairs of IP protocols and ports that the rule should match. - `ipProtocol` string — 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 (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP protocol number. - `ports` string[] — 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: ["22"],["80","443"], and ["12345-12349"]. - `destNetworkContext` 'INTERNET' | 'INTRA_VPC' | 'NON_INTERNET' | 'UNSPECIFIED' | 'VPC_NETWORKS' — Network context of the traffic destination. Allowed values are: - UNSPECIFIED - INTERNET - NON_INTERNET - `destIpRanges` string[] — CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - `srcRegionCodes` string[] — Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - `srcSecureTags` FirewallPolicyRuleSecureTag[] — List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - `name` string — Name of the secure tag, created with TagManager's TagValue API. - `state` 'EFFECTIVE' | 'INEFFECTIVE' — Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - `srcThreatIntelligences` string[] — Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - `srcNetworks` string[] — Networks of the traffic source. It can be either a full or partial url. - `destFqdns` string[] — Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - `destThreatIntelligences` string[] — Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - `securityProfileGroup` string — A fully-qualified URL of a SecurityProfileGroup resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. Can be specified only for global network firewall policies or hierarchical firewall policies. - `enableLogging` boolean — 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. - `rules` FirewallPolicyRule[] — A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. - `disabled` boolean — Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - `tlsInspect` boolean — Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - `description` string — An optional description for this resource. - `action` string — The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next" ( "apply_security_profile_group" can be specified only for global network firewall policies or hierarchical firewall policies). Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". - `targetType` 'INSTANCES' | 'INTERNAL_MANAGED_LB' — Target types of the firewall policy rule. Default value is INSTANCES. - `direction` 'EGRESS' | 'INGRESS' — The direction in which this rule applies. - `targetServiceAccounts` string[] — A list of service accounts indicating the sets of instances that are applied with this rule. - `kind` string — Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules. - `targetSecureTags` FirewallPolicyRuleSecureTag[] — A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts. If neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - `name` string — Name of the secure tag, created with TagManager's TagValue API. - `state` 'EFFECTIVE' | 'INEFFECTIVE' — Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - `ruleName` string — An optional name for the rule. This field is not a unique identifier and can be updated. - `targetForwardingRules` string[] — A list of forwarding rules to which this rule applies. This field allows you to control which load balancers get this rule. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/global/forwardingRules/forwardingRule - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule - projects/project/global/ forwardingRules/forwardingRule - projects/project/regions/region/forwardingRules/ forwardingRule - `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. - `targetResources` string[] — 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. - `ruleTupleCount` integer — Output only. [Output Only] Calculation of the complexity of a single firewall policy rule. - `match` FirewallPolicyRuleMatcher — Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. - `srcIpRanges` string[] — CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - `destAddressGroups` string[] — Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - `srcAddressGroups` string[] — Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - `srcFqdns` string[] — Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - `destRegionCodes` string[] — Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - `srcNetworkContext` 'INTERNET' | 'INTRA_VPC' | 'NON_INTERNET' | 'UNSPECIFIED' | 'VPC_NETWORKS' — Network context of the traffic source. Allowed values are: - UNSPECIFIED - INTERNET - INTRA_VPC - NON_INTERNET - VPC_NETWORKS - `srcNetworkType` 'INTERNET' | 'INTRA_VPC' | 'NON_INTERNET' | 'UNSPECIFIED' | 'VPC_NETWORKS' — Network type of the traffic source. Allowed values are: - UNSPECIFIED - INTERNET - INTRA_VPC - NON_INTERNET - VPC_NETWORKS - `destNetworkType` 'INTERNET' | 'INTRA_VPC' | 'NON_INTERNET' | 'UNSPECIFIED' | 'VPC_NETWORKS' — Network type of the traffic destination. Allowed values are: - UNSPECIFIED - INTERNET - NON_INTERNET - `layer4Configs` FirewallPolicyRuleMatcherLayer4Config[] — Pairs of IP protocols and ports that the rule should match. - `ipProtocol` string — 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 (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP protocol number. - `ports` string[] — 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: ["22"],["80","443"], and ["12345-12349"]. - `destNetworkContext` 'INTERNET' | 'INTRA_VPC' | 'NON_INTERNET' | 'UNSPECIFIED' | 'VPC_NETWORKS' — Network context of the traffic destination. Allowed values are: - UNSPECIFIED - INTERNET - NON_INTERNET - `destIpRanges` string[] — CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - `srcRegionCodes` string[] — Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - `srcSecureTags` FirewallPolicyRuleSecureTag[] — List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - `name` string — Name of the secure tag, created with TagManager's TagValue API. - `state` 'EFFECTIVE' | 'INEFFECTIVE' — Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - `srcThreatIntelligences` string[] — Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - `srcNetworks` string[] — Networks of the traffic source. It can be either a full or partial url. - `destFqdns` string[] — Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - `destThreatIntelligences` string[] — Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - `securityProfileGroup` string — A fully-qualified URL of a SecurityProfileGroup resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. Can be specified only for global network firewall policies or hierarchical firewall policies. - `enableLogging` boolean — 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. - `creationTimestamp` string — Output only. [Output Only] Creation timestamp inRFC3339 text format. - `policyType` 'RDMA_ROCE_POLICY' | 'ULL_POLICY' | 'VPC_POLICY' — The type of the firewall policy. This field can be one of VPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY. Note: if not specified then VPC_POLICY will be used. - `fingerprint` string, byte — Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. - `description` string — An optional description of this resource. Provide this property when you create the resource. - `region` string — Output only. [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - `shortName` string — User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - `parent` string — Output only. [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. - `kind` string — Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies - `name` string — Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. ## 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/versions/6120ed8969d4/schema)