Stay organized with collections Save and categorize content based on your preferences.
Retrieves an aggregated list of network firewall policies, listing network firewall policies from all applicable scopes (global and regional) and grouping the results per scope.
To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
GET https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/firewallPolicies
The URL uses gRPC Transcoding syntax.
Path parameters Parametersproject
string
Project ID for this request.
Query parameters ParametersmaxResults
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 proposal AIP-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 on resource 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 literal
fieldname 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 Google RE2 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.
includeAllScopes
boolean
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
serviceProjectNumber
string (int64 format)
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Request bodyThe request body must be empty.
Response bodyIf successful, the response body contains data with the following structure:
JSON representation{ "kind": string, "id": string, "items": { string: { "firewallPolicies": [ { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": 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 ], "srcNetworkType": enum, "srcNetworks": [ string ], "destNetworkType": enum }, "action": string, "securityProfileGroup": string, "tlsInspect": boolean, "direction": enum, "targetResources": [ string ], "enableLogging": boolean, "ruleTupleCount": integer, "targetServiceAccounts": [ string ], "targetSecureTags": [ { "name": string, "state": enum } ], "disabled": boolean } ], "packetMirroringRules": [ { "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 ], "srcNetworkType": enum, "srcNetworks": [ string ], "destNetworkType": enum }, "action": string, "securityProfileGroup": string, "tlsInspect": boolean, "direction": enum, "targetResources": [ string ], "enableLogging": boolean, "ruleTupleCount": integer, "targetServiceAccounts": [ string ], "targetSecureTags": [ { "name": string, "state": enum } ], "disabled": boolean } ], "fingerprint": string, "selfLink": string, "selfLinkWithId": string, "associations": [ { "name": string, "attachmentTarget": string, "firewallPolicyId": string, "shortName": string, "displayName": string } ], "ruleTupleCount": integer, "shortName": string, "displayName": string, "parent": string, "region": string } ], "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } }, ... }, "nextPageToken": string, "selfLink": string, "warning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] }, "unreachables": [ string ] }Fields
kind
string
[Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList
for lists of network firewall policies.
id
string
[Output Only] Unique identifier for the resource; defined by the server.
items
map (key: string, value: object)
A list of FirewallPoliciesScopedList resources.
Key: Name of the scope containing this set of addresses.
items.firewallPolicies[]
object
A list of firewall policies contained in this scope.
items.firewallPolicies[].kind
string
[Output only] Type of the resource. Always compute#firewallPolicy
for firewall policies
items.firewallPolicies[].id
string (uint64 format)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
items.firewallPolicies[].creationTimestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
items.firewallPolicies[].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.
items.firewallPolicies[].description
string
An optional description of this resource. Provide this property when you create the resource.
items.firewallPolicies[].rules[]
object
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.
items.firewallPolicies[].rules[].kind
string
[Output only] Type of the resource. Returns compute#firewallPolicyRule
for firewall rules and compute#packetMirroringRule
for packet mirroring rules.
items.firewallPolicies[].rules[].ruleName
string
An optional name for the rule. This field is not a unique identifier and can be updated.
items.firewallPolicies[].rules[].description
string
An optional description for this resource.
items.firewallPolicies[].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.
items.firewallPolicies[].rules[].match
object
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
items.firewallPolicies[].rules[].match.srcIpRanges[]
string
CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
items.firewallPolicies[].rules[].match.destIpRanges[]
string
CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
items.firewallPolicies[].rules[].match.layer4Configs[]
object
Pairs of IP protocols and ports that the rule should match.
items.firewallPolicies[].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.
items.firewallPolicies[].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"]
.
items.firewallPolicies[].rules[].match.srcSecureTags[]
object
networkFirewallPolicies.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.
items.firewallPolicies[].rules[].match.srcSecureTags[].name
string
Name of the secure tag, created with TagManager's TagValue API.
items.firewallPolicies[].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.
items.firewallPolicies[].rules[].match.destAddressGroups[]
string
Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
items.firewallPolicies[].rules[].match.srcAddressGroups[]
string
Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
items.firewallPolicies[].rules[].match.srcFqdns[]
string
Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
items.firewallPolicies[].rules[].match.destFqdns[]
string
Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
items.firewallPolicies[].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.
items.firewallPolicies[].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.
items.firewallPolicies[].rules[].match.destThreatIntelligences[]
string
Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
items.firewallPolicies[].rules[].match.srcThreatIntelligences[]
string
Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
items.firewallPolicies[].rules[].match.srcNetworkType
enum
Network type of the traffic source. Allowed values are:
UNSPECIFIED
INTERNET
INTRA_VPC
NON_INTERNET
VPC_NETWORKS
items.firewallPolicies[].rules[].match.srcNetworks[]
string
Networks of the traffic source. It can be either a full or partial url.
items.firewallPolicies[].rules[].match.destNetworkType
enum
Network type of the traffic destination. Allowed values are:
UNSPECIFIED
INTERNET
NON_INTERNET
items.firewallPolicies[].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".
items.firewallPolicies[].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.
items.firewallPolicies[].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.
items.firewallPolicies[].rules[].direction
enum
The direction in which this rule applies.
items.firewallPolicies[].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.
items.firewallPolicies[].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.
items.firewallPolicies[].rules[].ruleTupleCount
integer
[Output Only] Calculation of the complexity of a single firewall policy rule.
items.firewallPolicies[].rules[].targetServiceAccounts[]
string
A list of service accounts indicating the sets of instances that are applied with this rule.
items.firewallPolicies[].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.
items.firewallPolicies[].rules[].targetSecureTags[].name
string
Name of the secure tag, created with TagManager's TagValue API.
items.firewallPolicies[].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.
items.firewallPolicies[].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.
items.firewallPolicies[].packetMirroringRules[]
object
A list of packet mirroring rules that belong to this policy.
items.firewallPolicies[].packetMirroringRules[].kind
string
[Output only] Type of the resource. Returns compute#firewallPolicyRule
for firewall rules and compute#packetMirroringRule
for packet mirroring rules.
items.firewallPolicies[].packetMirroringRules[].ruleName
string
An optional name for the rule. This field is not a unique identifier and can be updated.
items.firewallPolicies[].packetMirroringRules[].description
string
An optional description for this resource.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].match
object
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
items.firewallPolicies[].packetMirroringRules[].match.srcIpRanges[]
string
CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
items.firewallPolicies[].packetMirroringRules[].match.destIpRanges[]
string
CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
items.firewallPolicies[].packetMirroringRules[].match.layer4Configs[]
object
Pairs of IP protocols and ports that the rule should match.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].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"]
.
items.firewallPolicies[].packetMirroringRules[].match.srcSecureTags[]
object
networkFirewallPolicies.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.
items.firewallPolicies[].packetMirroringRules[].match.srcSecureTags[].name
string
Name of the secure tag, created with TagManager's TagValue API.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].match.destAddressGroups[]
string
Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
items.firewallPolicies[].packetMirroringRules[].match.srcAddressGroups[]
string
Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
items.firewallPolicies[].packetMirroringRules[].match.srcFqdns[]
string
Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
items.firewallPolicies[].packetMirroringRules[].match.destFqdns[]
string
Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].match.destThreatIntelligences[]
string
Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
items.firewallPolicies[].packetMirroringRules[].match.srcThreatIntelligences[]
string
Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
items.firewallPolicies[].packetMirroringRules[].match.srcNetworkType
enum
Network type of the traffic source. Allowed values are:
UNSPECIFIED
INTERNET
INTRA_VPC
NON_INTERNET
VPC_NETWORKS
items.firewallPolicies[].packetMirroringRules[].match.srcNetworks[]
string
Networks of the traffic source. It can be either a full or partial url.
items.firewallPolicies[].packetMirroringRules[].match.destNetworkType
enum
Network type of the traffic destination. Allowed values are:
UNSPECIFIED
INTERNET
NON_INTERNET
items.firewallPolicies[].packetMirroringRules[].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".
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].direction
enum
The direction in which this rule applies.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].ruleTupleCount
integer
[Output Only] Calculation of the complexity of a single firewall policy rule.
items.firewallPolicies[].packetMirroringRules[].targetServiceAccounts[]
string
A list of service accounts indicating the sets of instances that are applied with this rule.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].targetSecureTags[].name
string
Name of the secure tag, created with TagManager's TagValue API.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].packetMirroringRules[].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.
items.firewallPolicies[].fingerprint
string (bytes format)
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 error 412 conditionNotMet
.
To see the latest fingerprint, make get()
request to the firewall policy.
A base64-encoded string.
items.firewallPolicies[].selfLink
string
[Output Only] Server-defined URL for the resource.
items.firewallPolicies[].selfLinkWithId
string
[Output Only] Server-defined URL for this resource with the resource id.
items.firewallPolicies[].associations[]
object
A list of associations that belong to this firewall policy.
items.firewallPolicies[].associations[].name
string
The name for an association.
items.firewallPolicies[].associations[].attachmentTarget
string
The target that the firewall policy is attached to.
items.firewallPolicies[].associations[].firewallPolicyId
string
[Output Only] The firewall policy ID of the association.
items.firewallPolicies[].associations[].shortName
string
[Output Only] The short name of the firewall policy of the association.
items.firewallPolicies[].associations[].displayName
(deprecated)
string
[Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
items.firewallPolicies[].ruleTupleCount
integer
[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
items.firewallPolicies[].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.
items.firewallPolicies[].displayName
(deprecated)
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.
items.firewallPolicies[].parent
string
[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
items.firewallPolicies[].region
string
[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.
items.warning
object
Informational warning which replaces the list of firewall policies when the list is empty.
items.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.
items.warning.message
string
[Output Only] A human-readable description of the warning code.
items.warning.data[]
object
[Output Only] Metadata about this warning in key: value
format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
items.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).
items.warning.data[].value
string
[Output Only] A warning data value corresponding to the key.
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.
unreachables[]
string
[Output Only] Unreachable resources.
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.
IAM PermissionsIn addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.firewallPolicies.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["This API retrieves an aggregated list of network firewall policies from all applicable scopes, with an optional parameter `returnPartialSuccess` for handling partial failures."],["The HTTP request is a `GET` method directed to a specific endpoint that includes a project identifier in the path: `https://compute.googleapis.com/compute/v1/projects/{project}/aggregated/firewallPolicies`."],["Path parameters for this request include the `project` ID, and it also supports several query parameters such as `maxResults`, `pageToken`, `filter`, `orderBy`, `returnPartialSuccess`, `includeAllScopes`, and `serviceProjectNumber` to modify the results."],["The response body is a JSON format containing a comprehensive structure, including details about the firewall policies, packet mirroring rules, metadata, warnings, and other related information, including the ability to identify and manage scopes, resource URLs, and rule application for network security management."],["The firewall policies and packet mirroring rules have multiple configurations, such as traffic matching conditions with ranges, protocols, tags, and various actions like allow, deny, and mirror."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4