Method: firewalls.list

Retrieves the list of firewall rules available to the specified project.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/firewalls

The URL usesgRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to theservice error catalog

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.

project

string

Project ID for this request.

Query parameters

Parameters
`maxResults`	`integer (uint32 format)` The maximum number of results per page that should be returned. If the number of available results is larger than`maxResults`, Compute Engine returns a`nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are`0` to`500`, inclusive. (Default:`500`)
`pageToken`	`string` Specifies a page token to use. Set`pageToken` to the`nextPageToken` returned by a previous list request to get the next page of results.
`filter`	`string` A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposalAIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either`=`,`!=`,`>`,`<`,`<=`,`>=` or`:`. For example, if you are filtering Compute Engine instances, you can exclude instances named`example-instance` by specifying`name != example-instance`. The`:` comparison can be used to test whether a key has been defined. For example, to find all objects with`owner` label use: `labels.owner:` You can also filter nested fields. For example, you could specify`scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: `(scheduling.automaticRestart = true)(cpuPlatform = "Intel Skylake")` By default, each expression is an`AND` expression. However, you can include`AND` and`OR` expressions explicitly. For example: `(cpuPlatform = "Intel Skylake") OR(cpuPlatform = "Intel Broadwell") AND(scheduling.automaticRestart = true)` If you want to use a regular expression, use the`eq` (equal) or`ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literalfieldname eq 'single quoted literal'fieldname eq "double quoted literal"(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use`name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
`orderBy`	`string` Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using`orderBy="creationTimestamp desc"`. This sorts results based on the`creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by`name` or`creationTimestamp desc` is supported.
`returnPartialSuccess`	`boolean` Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

Contains a list of firewalls.

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

JSON representation
{"kind":string,"id":string,"items":[{"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,"enableLogging":boolean,"logConfig":{"enable":boolean,"metadata":enum},"disabled":boolean,"selfLink":string,"params":{"resourceManagerTags":{string:string,...}}}],"nextPageToken":string,"selfLink":string,"warning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}

JSON representation

{"kind":string,"id":string,"items":[{"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,"enableLogging":boolean,"logConfig":{"enable":boolean,"metadata":enum},"disabled":boolean,"selfLink":string,"params":{"resourceManagerTags":{string:string,...}}}],"nextPageToken":string,"selfLink":string,"warning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}

Fields
`kind`	`string` [Output Only] Type of resource. Always`compute#firewallList` for lists of firewalls.
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of Firewall resources.
`items[].kind`	`string` [Output Only] Type of the resource. Always`compute#firewall` for firewall rules.
`items[].id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].creationTimestamp`	`string` [Output Only] Creation timestamp inRFC3339 text format.
`items[].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 withRFC1035. 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.
`items[].description`	`string` An optional description of this resource. Provide this field when you create the resource.
`items[].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: `https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network` `projects/myproject/global/networks/my-network` `global/networks/default`
`items[].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 haveimplied rules with a priority of`65535`. To avoid conflicts with the implied rules, use a priority number less than`65535`.
`items[].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 inCIDR 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.
`items[].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 inCIDR format. Both IPv4 and IPv6 are supported.
`items[].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.
`items[].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.
`items[].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`.
`items[].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.
`items[].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.
`items[].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.
`items[].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"]`.
`items[].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.
`items[].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.
`items[].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"]`.
`items[].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.
`items[].enableLogging (deprecated)`	`boolean` Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.
`items[].logConfig`	`object` This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.
`items[].logConfig.enable`	`boolean` This field denotes whether to enable logging for a particular firewall rule.
`items[].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.
`items[].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.
`items[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items[].params`	`object` Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
`items[].params.resourceManagerTags`	`map (key: string, value: string)` Tag keys/values directly bound to this resource. Tag keys and values have the same definition asresource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { :} or Namespaced format { :}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} * {"123/environment" : "production", "345/abc" : "xyz"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"} is invalid.
`nextPageToken`	`string` [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than`maxResults`, use the`nextPageToken` as a value for the query parameter`pageToken` in the next list request. Subsequent list requests will have their own`nextPageToken` to continue paging through the results.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`warning`	`object` [Output Only] Informational warning message.
`warning.code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns`NO_RESULTS_ON_PAGE` if there are no results in the response.
`warning.message`	`string` [Output Only] A human-readable description of the warning code.
`warning.data[]`	`object` [Output Only] Metadata about this warning in`key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warning.data[].key`	`string` [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`scope` and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
`warning.data[].value`	`string` [Output Only] A warning data value corresponding to the key.

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 theAuthentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the followingIAM permissions:

compute.firewalls.list

To find predefined roles that contain those permissions, seeCompute Engine IAM Roles.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-18 UTC.

Movatterモバイル変換

Method: firewalls.list Stay organized with collections Save and categorize content based on your preferences.