Method: regionNetworkFirewallPolicies.getEffectiveFirewalls

Returns the effective firewalls on a given network.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
region

string

Name of the region scoping this request.

Query parameters

Parameters
network

string

Network reference

Authorization requires the following IAM permission on the specified resource network:

  • compute.networks.getRegionEffectiveFirewalls

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "firewalls": [
    {
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "network": string,
      "priority": integer,
      "sourceRanges": [
        string
      ],
      "destinationRanges": [
        string
      ],
      "sourceTags": [
        string
      ],
      "targetTags": [
        string
      ],
      "sourceServiceAccounts": [
        string
      ],
      "targetServiceAccounts": [
        string
      ],
      "allowed": [
        {
          "IPProtocol": string,
          "ports": [
            string
          ]
        }
      ],
      "denied": [
        {
          "IPProtocol": string,
          "ports": [
            string
          ]
        }
      ],
      "direction": enum,
      "logConfig": {
        "enable": boolean,
        "metadata": enum
      },
      "disabled": boolean,
      "selfLink": string
    }
  ],
  "firewallPolicys": [
    {
      "name": string,
      "type": enum,
      "displayName": string,
      "rules": [
        {
          "kind": string,
          "ruleName": string,
          "description": string,
          "priority": integer,
          "match": {
            "srcIpRanges": [
              string
            ],
            "destIpRanges": [
              string
            ],
            "layer4Configs": [
              {
                "ipProtocol": string,
                "ports": [
                  string
                ]
              }
            ],
            "srcSecureTags": [
              {
                "name": string,
                "state": enum
              }
            ],
            "destAddressGroups": [
              string
            ],
            "srcAddressGroups": [
              string
            ],
            "srcFqdns": [
              string
            ],
            "destFqdns": [
              string
            ],
            "srcRegionCodes": [
              string
            ],
            "destRegionCodes": [
              string
            ],
            "destThreatIntelligences": [
              string
            ],
            "srcThreatIntelligences": [
              string
            ]
          },
          "action": string,
          "securityProfileGroup": string,
          "tlsInspect": boolean,
          "direction": enum,
          "targetResources": [
            string
          ],
          "enableLogging": boolean,
          "ruleTupleCount": integer,
          "targetServiceAccounts": [
            string
          ],
          "targetSecureTags": [
            {
              "name": string,
              "state": enum
            }
          ],
          "disabled": boolean
        }
      ]
    }
  ]
}
Fields
firewalls[]

object

Effective firewalls on the network.
firewalls[].kind

string

[Output Only] Type of the resource. Always compute#firewall for firewall rules.
firewalls[].id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
firewalls[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
firewalls[].name

string

Name of the resource; provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
firewalls[].description

string

An optional description of this resource. Provide this field when you create the resource.
firewalls[].network

string

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: 

global/networks/default
If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

firewalls[].priority

integer

Priority for this rule. This is an integer between 0 and 65535, both inclusive. The default value is 1000. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority 0 has higher precedence than a rule with priority 1. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of 65535. To avoid conflicts with the implied rules, use a priority number less than 65535.
firewalls[].sourceRanges[]

string

If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.
firewalls[].destinationRanges[]

string

If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.
firewalls[].sourceTags[]

string

If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.
firewalls[].targetTags[]

string

A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
firewalls[].sourceServiceAccounts[]

string

If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.
firewalls[].targetServiceAccounts[]

string

A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.
firewalls[].allowed[]

object

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
firewalls[].allowed[].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.
firewalls[].allowed[].ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for the 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"].
firewalls[].denied[]

object

The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.
firewalls[].denied[].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.
firewalls[].denied[].ports[]

string

An optional list of ports to which this rule applies. This field is only applicable for the 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"].
firewalls[].direction

enum

Direction of traffic to which this firewall applies, either INGRESS or EGRESS. The default is INGRESS. For EGRESS traffic, you cannot specify the sourceTags fields.
firewalls[].logConfig

object

This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.
firewalls[].logConfig.enable

boolean

This field denotes whether to enable logging for a particular firewall rule.
firewalls[].logConfig.metadata

enum

This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.
firewalls[].disabled

boolean

Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.
firewalls[].selfLink

string

[Output Only] Server-defined URL for the resource.
firewallPolicys[]

object

[Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network.
firewallPolicys[].name

string

[Output Only] The name of the firewall policy.
firewallPolicys[].type

enum

[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.
firewallPolicys[].displayName

string

[Output Only] The display name of the firewall policy.
firewallPolicys[].rules[]

object

[Output only] The rules that apply to the network.
firewallPolicys[].rules[].kind

string

[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
firewallPolicys[].rules[].ruleName

string

An optional name for the rule. This field is not a unique identifier and can be updated.
firewallPolicys[].rules[].description

string

An optional description for this resource.
firewallPolicys[].rules[].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.
firewallPolicys[].rules[].match

object

A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
firewallPolicys[].rules[].match.srcIpRanges[]

string

CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
firewallPolicys[].rules[].match.destIpRanges[]

string

CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
firewallPolicys[].rules[].match.layer4Configs[]

object

Pairs of IP protocols and ports that the rule should match.
firewallPolicys[].rules[].match.layer4Configs[].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.
firewallPolicys[].rules[].match.layer4Configs[].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"].
firewallPolicys[].rules[].match.srcSecureTags[]

object

regionNetworkFirewallPolicies.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.
firewallPolicys[].rules[].match.srcSecureTags[].name

string

Name of the secure tag, created with TagManager's TagValue API.
firewallPolicys[].rules[].match.srcSecureTags[].state

enum

[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.
firewallPolicys[].rules[].match.destAddressGroups[]

string

Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
firewallPolicys[].rules[].match.srcAddressGroups[]

string

Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
firewallPolicys[].rules[].match.srcFqdns[]

string

Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
firewallPolicys[].rules[].match.destFqdns[]

string

Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
firewallPolicys[].rules[].match.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.
firewallPolicys[].rules[].match.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.
firewallPolicys[].rules[].match.destThreatIntelligences[]

string

Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
firewallPolicys[].rules[].match.srcThreatIntelligences[]

string

Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
firewallPolicys[].rules[].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". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
firewallPolicys[].rules[].securityProfileGroup

string

A fully-qualified URL of a SecurityProfile 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.
firewallPolicys[].rules[].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.
firewallPolicys[].rules[].direction

enum

The direction in which this rule applies.
firewallPolicys[].rules[].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.
firewallPolicys[].rules[].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.
firewallPolicys[].rules[].ruleTupleCount

integer

[Output Only] Calculation of the complexity of a single firewall policy rule.
firewallPolicys[].rules[].targetServiceAccounts[]

string

A list of service accounts indicating the sets of instances that are applied with this rule.
firewallPolicys[].rules[].targetSecureTags[]

object

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 targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
firewallPolicys[].rules[].targetSecureTags[].name

string

Name of the secure tag, created with TagManager's TagValue API.
firewallPolicys[].rules[].targetSecureTags[].state

enum

[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.
firewallPolicys[].rules[].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.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.