Method: securityPolicies.aggregatedList

Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.

To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/aggregated/securityPolicies

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Name of the project scoping 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 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 body

The request body must be empty.

Response body

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

JSON representation 
{
  "kind": string,
  "id": string,
  "items": {
    string: {
      "securityPolicies": [
        {
          "userDefinedFields": [
            {
              "name": string,
              "base": enum,
              "offset": integer,
              "size": integer,
              "mask": string
            }
          ],
          "kind": string,
          "id": string,
          "creationTimestamp": string,
          "name": string,
          "description": string,
          "rules": [
            {
              "kind": string,
              "description": string,
              "priority": integer,
              "match": {
                "expr": {
                  "expression": string,
                  "title": string,
                  "description": string,
                  "location": string
                },
                "exprOptions": {
                  "recaptchaOptions": {
                    "actionTokenSiteKeys": [
                      string
                    ],
                    "sessionTokenSiteKeys": [
                      string
                    ]
                  }
                },
                "versionedExpr": enum,
                "config": {
                  "srcIpRanges": [
                    string
                  ],
                  "destIpRanges": [
                    string
                  ],
                  "layer4Configs": [
                    {
                      "ipProtocol": string,
                      "ports": [
                        string
                      ]
                    }
                  ]
                }
              },
              "networkMatch": {
                "userDefinedFields": [
                  {
                    "name": string,
                    "values": [
                      string
                    ]
                  }
                ],
                "srcIpRanges": [
                  string
                ],
                "destIpRanges": [
                  string
                ],
                "ipProtocols": [
                  string
                ],
                "srcPorts": [
                  string
                ],
                "destPorts": [
                  string
                ],
                "srcRegionCodes": [
                  string
                ],
                "srcAsns": [
                  integer
                ]
              },
              "action": string,
              "preview": boolean,
              "direction": enum,
              "targetResources": [
                string
              ],
              "enableLogging": boolean,
              "ruleTupleCount": integer,
              "rateLimitOptions": {
                "rateLimitThreshold": {
                  "count": integer,
                  "intervalSec": integer
                },
                "conformAction": string,
                "exceedAction": string,
                "exceedRedirectOptions": {
                  "type": enum,
                  "target": string
                },
                "enforceOnKey": enum,
                "enforceOnKeyName": string,
                "enforceOnKeyConfigs": [
                  {
                    "enforceOnKeyType": enum,
                    "enforceOnKeyName": string
                  }
                ],
                "banThreshold": {
                  "count": integer,
                  "intervalSec": integer
                },
                "banDurationSec": integer
              },
              "targetServiceAccounts": [
                string
              ],
              "ruleNumber": string,
              "headerAction": {
                "requestHeadersToAdds": [
                  {
                    "headerName": string,
                    "headerValue": string
                  }
                ]
              },
              "redirectOptions": {
                "type": enum,
                "target": string
              },
              "preconfiguredWafConfig": {
                "exclusions": [
                  {
                    "targetRuleSet": string,
                    "targetRuleIds": [
                      string
                    ],
                    "requestHeadersToExclude": [
                      {
                        "val": string,
                        "op": enum
                      }
                    ],
                    "requestCookiesToExclude": [
                      {
                        "val": string,
                        "op": enum
                      }
                    ],
                    "requestQueryParamsToExclude": [
                      {
                        "val": string,
                        "op": enum
                      }
                    ],
                    "requestUrisToExclude": [
                      {
                        "val": string,
                        "op": enum
                      }
                    ]
                  }
                ]
              }
            }
          ],
          "adaptiveProtectionConfig": {
            "layer7DdosDefenseConfig": {
              "enable": boolean,
              "ruleVisibility": enum,
              "thresholdConfigs": [
                {
                  "name": string,
                  "autoDeployLoadThreshold": number,
                  "autoDeployConfidenceThreshold": number,
                  "autoDeployImpactedBaselineThreshold": number,
                  "autoDeployExpirationSec": integer,
                  "detectionLoadThreshold": number,
                  "detectionAbsoluteQps": number,
                  "detectionRelativeToBaselineQps": number,
                  "trafficGranularityConfigs": [
                    {
                      "type": enum,
                      "value": string,
                      "enableEachUniqueValue": boolean
                    }
                  ]
                }
              ]
            },
            "autoDeployConfig": {
              "loadThreshold": number,
              "confidenceThreshold": number,
              "impactedBaselineThreshold": number,
              "expirationSec": integer
            }
          },
          "ddosProtectionConfig": {
            "ddosProtection": enum
          },
          "advancedOptionsConfig": {
            "jsonParsing": enum,
            "jsonCustomConfig": {
              "contentTypes": [
                string
              ]
            },
            "logLevel": enum,
            "userIpRequestHeaders": [
              string
            ]
          },
          "recaptchaOptionsConfig": {
            "redirectSiteKey": string
          },
          "fingerprint": string,
          "selfLink": string,
          "selfLinkWithId": string,
          "type": enum,
          "associations": [
            {
              "name": string,
              "attachmentId": string,
              "excludedProjects": [
                string
              ],
              "excludedFolders": [
                string
              ],
              "securityPolicyId": string,
              "shortName": string,
              "displayName": string
            }
          ],
          "labels": {
            string: string,
            ...
          },
          "labelFingerprint": string,
          "ruleTupleCount": integer,
          "displayName": string,
          "shortName": 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
      }
    ]
  },
  "etag": string,
  "unreachables": [
    string
  ]
}
Fields
kind

string

[Output Only] Type of resource. Always compute#securityPolicyAggregatedList for lists of Security Policies.
id

string

[Output Only] Unique identifier for the resource; defined by the server.
items

map (key: string, value: object)

A list of SecurityPoliciesScopedList resources.

Key: Name of the scope containing this set of security policies.
items.securityPolicies[]

object

A list of SecurityPolicies contained in this scope.
items.securityPolicies[].userDefinedFields[]

object

Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields.

Example:

userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"
items.securityPolicies[].userDefinedFields[].name

string

The name of this field. Must be unique within the policy.
items.securityPolicies[].userDefinedFields[].base

enum

The base relative to which 'offset' is measured. Possible values are:

  • IPV4: Points to the beginning of the IPv4 header.
  • IPV6: Points to the beginning of the IPv6 header.
  • TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.
  • UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments.
required
items.securityPolicies[].userDefinedFields[].offset

integer

Offset of the first byte of the field (in network byte order) relative to 'base'.
items.securityPolicies[].userDefinedFields[].size

integer

Size of the field in bytes. Valid values: 1-4.
items.securityPolicies[].userDefinedFields[].mask

string

If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.
items.securityPolicies[].kind

string

[Output only] Type of the resource. Always compute#securityPolicyfor security policies
items.securityPolicies[].id

string (uint64 format)

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

string

[Output Only] Creation timestamp in RFC3339 text format.
items.securityPolicies[].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])? 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.securityPolicies[].description

string

An optional description of this resource. Provide this property when you create the resource.
items.securityPolicies[].rules[]

object

A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
items.securityPolicies[].rules[].kind

string

[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
items.securityPolicies[].rules[].description

string

An optional description of this resource. Provide this property when you create the resource.
items.securityPolicies[].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.securityPolicies[].rules[].match

object

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

object

User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing evaluateThreatIntelligence require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing evaluatePreconfiguredExpr('sourceiplist-*') require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.
items.securityPolicies[].rules[].match.expr.expression

string

Textual representation of an expression in Common Expression Language syntax.
items.securityPolicies[].rules[].match.expr.title

string

Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
items.securityPolicies[].rules[].match.expr.description

string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
items.securityPolicies[].rules[].match.expr.location

string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
items.securityPolicies[].rules[].match.exprOptions

object

The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
items.securityPolicies[].rules[].match.exprOptions.recaptchaOptions

object

reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.
items.securityPolicies[].rules[].match.exprOptions.recaptchaOptions.actionTokenSiteKeys[]

string

A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
items.securityPolicies[].rules[].match.exprOptions.recaptchaOptions.sessionTokenSiteKeys[]

string

A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
items.securityPolicies[].rules[].match.versionedExpr

enum

Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding srcIpRange field in config.
items.securityPolicies[].rules[].match.config

object

The configuration options available when specifying versionedExpr. This field must be specified if versionedExpr is specified and cannot be specified if versionedExpr is not specified.
items.securityPolicies[].rules[].match.config.srcIpRanges[]

string

CIDR IP address range. Maximum number of srcIpRanges allowed is 10.
items.securityPolicies[].rules[].match.config.destIpRanges[]
(deprecated)

string

CIDR IP address range.

This field may only be specified when versionedExpr is set to FIREWALL.
items.securityPolicies[].rules[].match.config.layer4Configs[]
(deprecated)

object

Pairs of IP protocols and ports that the rule should match.

This field may only be specified when versionedExpr is set to FIREWALL.
items.securityPolicies[].rules[].match.config.layer4Configs[]
(deprecated).ipProtocol
(deprecated)

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.securityPolicies[].rules[].match.config.layer4Configs[]
(deprecated).ports[]
(deprecated)

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"].

This field may only be specified when versionedExpr is set to FIREWALL.
items.securityPolicies[].rules[].networkMatch

object

A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced.

The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields').

Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds.

Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all.

For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet.

Example:

networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff"

The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
items.securityPolicies[].rules[].networkMatch.userDefinedFields[]

object

User-defined fields. Each element names a defined field and lists the matching values for that field.
items.securityPolicies[].rules[].networkMatch.userDefinedFields[].name

string

Name of the user-defined field, as given in the definition.
items.securityPolicies[].rules[].networkMatch.userDefinedFields[].values[]

string

Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").
items.securityPolicies[].rules[].networkMatch.srcIpRanges[]

string

Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
items.securityPolicies[].rules[].networkMatch.destIpRanges[]

string

Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
items.securityPolicies[].rules[].networkMatch.ipProtocols[]

string

IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
items.securityPolicies[].rules[].networkMatch.srcPorts[]

string

Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
items.securityPolicies[].rules[].networkMatch.destPorts[]

string

Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
items.securityPolicies[].rules[].networkMatch.srcRegionCodes[]

string

Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
items.securityPolicies[].rules[].networkMatch.srcAsns[]

integer (uint32 format)

BGP Autonomous System Number associated with the source IP address.
items.securityPolicies[].rules[].action

string

The Action to perform when the rule is matched. The following are the valid actions:

  • allow: allow access to target.
  • deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for STATUS are 403, 404, and 502.
  • rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rateLimitOptions to be set.
  • redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR.
  • throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rateLimitOptions to be set for this.
items.securityPolicies[].rules[].preview

boolean

If set to true, the specified action is not enforced.
items.securityPolicies[].rules[].direction
(deprecated)

enum

The direction in which this rule applies. This field may only be specified when versionedExpr is set to FIREWALL.
items.securityPolicies[].rules[].targetResources[]
(deprecated)

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.

This field may only be specified when versionedExpr is set to FIREWALL.
items.securityPolicies[].rules[].enableLogging
(deprecated)

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.

This field may only be specified when the versionedExpr is set to FIREWALL.
items.securityPolicies[].rules[].ruleTupleCount
(deprecated)

integer

[Output Only] Calculation of the complexity of a single firewall security policy rule.
items.securityPolicies[].rules[].rateLimitOptions

object

Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.
items.securityPolicies[].rules[].rateLimitOptions.rateLimitThreshold

object

Threshold at which to begin ratelimiting.
items.securityPolicies[].rules[].rateLimitOptions.rateLimitThreshold.count

integer

Number of HTTP(S) requests for calculating the threshold.
items.securityPolicies[].rules[].rateLimitOptions.rateLimitThreshold.intervalSec

integer

Interval over which the threshold is computed.
items.securityPolicies[].rules[].rateLimitOptions.conformAction

string

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
items.securityPolicies[].rules[].rateLimitOptions.exceedAction

string

Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are deny(STATUS), where valid values for STATUS are 403, 404, 429, and 502, and redirect, where the redirect parameters come from exceedRedirectOptions below. The redirect action is only supported in Global Security Policies of type CLOUD_ARMOR.
items.securityPolicies[].rules[].rateLimitOptions.exceedRedirectOptions

object

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
items.securityPolicies[].rules[].rateLimitOptions.exceedRedirectOptions.type

enum

Type of the redirect action.
items.securityPolicies[].rules[].rateLimitOptions.exceedRedirectOptions.target

string

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
items.securityPolicies[].rules[].rateLimitOptions.enforceOnKey

enum

Determines the key to enforce the rateLimitThreshold on. Possible values are:

  • ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured.
  • IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
  • HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
  • XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
  • HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
  • HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
  • SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
  • REGION_CODE: The country/region from which the request originates.
  • TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
  • USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP.

items.securityPolicies[].rules[].rateLimitOptions.enforceOnKeyName

string

Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
items.securityPolicies[].rules[].rateLimitOptions.enforceOnKeyConfigs[]

object

If specified, any combination of values of enforceOnKeyType/enforceOnKeyName is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforceOnKeyConfigs. If enforceOnKeyConfigs is specified, enforceOnKey must not be specified.
items.securityPolicies[].rules[].rateLimitOptions.enforceOnKeyConfigs[].enforceOnKeyType

enum

Determines the key to enforce the rateLimitThreshold on. Possible values are:

  • ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured.
  • IP: The source IP address of the request is the key. Each IP has this limit enforced separately.
  • HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL.
  • XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP.
  • HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.
  • HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes.
  • SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session.
  • REGION_CODE: The country/region from which the request originates.
  • TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
  • USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP.

items.securityPolicies[].rules[].rateLimitOptions.enforceOnKeyConfigs[].enforceOnKeyName

string

Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
items.securityPolicies[].rules[].rateLimitOptions.banThreshold

object

Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'banDurationSec' when the number of requests that exceed the 'rateLimitThreshold' also exceed this 'banThreshold'.
items.securityPolicies[].rules[].rateLimitOptions.banThreshold.count

integer

Number of HTTP(S) requests for calculating the threshold.
items.securityPolicies[].rules[].rateLimitOptions.banThreshold.intervalSec

integer

Interval over which the threshold is computed.
items.securityPolicies[].rules[].rateLimitOptions.banDurationSec

integer

Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
items.securityPolicies[].rules[].targetServiceAccounts[]
(deprecated)

string

A list of service accounts indicating the sets of instances that are applied with this rule.
items.securityPolicies[].rules[].ruleNumber

string (int64 format)

Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.
items.securityPolicies[].rules[].headerAction

object

Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
items.securityPolicies[].rules[].headerAction.requestHeadersToAdds[]

object

The list of request headers to add or overwrite if they're already present.
items.securityPolicies[].rules[].headerAction.requestHeadersToAdds[].headerName

string

The name of the header to set.
items.securityPolicies[].rules[].headerAction.requestHeadersToAdds[].headerValue

string

The value to set the named header to.
items.securityPolicies[].rules[].redirectOptions

object

Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
items.securityPolicies[].rules[].redirectOptions.type

enum

Type of the redirect action.
items.securityPolicies[].rules[].redirectOptions.target

string

Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
items.securityPolicies[].rules[].preconfiguredWafConfig

object

Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[]

object

A list of exclusions to apply during preconfigured WAF evaluation.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].targetRuleSet

string

Target WAF rule set to apply the preconfigured WAF exclusion.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].targetRuleIds[]

string

A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestHeadersToExclude[]

object

A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestHeadersToExclude[].val

string

The value of the field.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestHeadersToExclude[].op

enum

The match operator for the field.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[]

object

A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[].val

string

The value of the field.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestCookiesToExclude[].op

enum

The match operator for the field.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestQueryParamsToExclude[]

object

A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestQueryParamsToExclude[].val

string

The value of the field.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestQueryParamsToExclude[].op

enum

The match operator for the field.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestUrisToExclude[]

object

A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestUrisToExclude[].val

string

The value of the field.
items.securityPolicies[].rules[].preconfiguredWafConfig.exclusions[].requestUrisToExclude[].op

enum

The match operator for the field.
items.securityPolicies[].adaptiveProtectionConfig

object
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig

object

If set to true, enables Cloud Armor Machine Learning.
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.enable

boolean

If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.ruleVisibility

enum

Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[]

object

Configuration options for layer7 adaptive protection for various customizable thresholds.
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].name

string

The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployLoadThreshold

number
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployConfidenceThreshold

number
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployImpactedBaselineThreshold

number
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].autoDeployExpirationSec

integer
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionLoadThreshold

number
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionAbsoluteQps

number
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].detectionRelativeToBaselineQps

number
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[]

object

Configuration options for enabling Adaptive Protection to operate on specified granular traffic units.
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].type

enum

Type of this configuration.
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].value

string

Requests that match this value constitute a granular traffic unit.
items.securityPolicies[].adaptiveProtectionConfig.layer7DdosDefenseConfig.thresholdConfigs[].trafficGranularityConfigs[].enableEachUniqueValue

boolean

If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if value is empty.
items.securityPolicies[].adaptiveProtectionConfig.autoDeployConfig

object
items.securityPolicies[].adaptiveProtectionConfig.autoDeployConfig.loadThreshold

number
items.securityPolicies[].adaptiveProtectionConfig.autoDeployConfig.confidenceThreshold

number
items.securityPolicies[].adaptiveProtectionConfig.autoDeployConfig.impactedBaselineThreshold

number
items.securityPolicies[].adaptiveProtectionConfig.autoDeployConfig.expirationSec

integer
items.securityPolicies[].ddosProtectionConfig

object
items.securityPolicies[].ddosProtectionConfig.ddosProtection

enum
items.securityPolicies[].advancedOptionsConfig

object
items.securityPolicies[].advancedOptionsConfig.jsonParsing

enum
items.securityPolicies[].advancedOptionsConfig.jsonCustomConfig

object

Custom configuration to apply the JSON parsing. Only applicable when jsonParsing is set to STANDARD.
items.securityPolicies[].advancedOptionsConfig.jsonCustomConfig.contentTypes[]

string

A list of custom Content-Type header values to apply the JSON parsing.

As per RFC 1341, a Content-Type header value has the following format:

Content-Type := type "/" subtype *[";" parameter]

When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.
items.securityPolicies[].advancedOptionsConfig.logLevel

enum
items.securityPolicies[].advancedOptionsConfig.userIpRequestHeaders[]

string

An optional list of case-insensitive request header names to use for resolving the callers client IP address.
items.securityPolicies[].recaptchaOptionsConfig

object
items.securityPolicies[].recaptchaOptionsConfig.redirectSiteKey

string

An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
items.securityPolicies[].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 security policy.

A base64-encoded string.
items.securityPolicies[].selfLink

string

[Output Only] Server-defined URL for the resource.
items.securityPolicies[].selfLinkWithId

string

[Output Only] Server-defined URL for this resource with the resource id.
items.securityPolicies[].type

enum

The type indicates the intended use of the security policy.

  • CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.
  • CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache.
  • CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application.
  • CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application.
    • This field can be set only at resource creation time.
    items.securityPolicies[].associations[]

    object

    A list of associations that belong to this policy.
    items.securityPolicies[].associations[].name

    string

    The name for an association.
    items.securityPolicies[].associations[].attachmentId

    string

    The resource that the security policy is attached to.
    items.securityPolicies[].associations[].excludedProjects[]

    string

    A list of projects to exclude from the security policy.
    items.securityPolicies[].associations[].excludedFolders[]

    string

    A list of folders to exclude from the security policy.
    items.securityPolicies[].associations[].securityPolicyId

    string

    [Output Only] The security policy ID of the association.
    items.securityPolicies[].associations[].shortName

    string

    [Output Only] The short name of the security policy of the association.
    items.securityPolicies[].associations[].displayName
    (deprecated)

    string

    [Output Only] The display name of the security policy of the association.
    items.securityPolicies[].labels

    map (key: string, value: string)

    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    items.securityPolicies[].labelFingerprint

    string (bytes format)

    A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

    To see the latest fingerprint, make get() request to the security policy.

    A base64-encoded string.
    items.securityPolicies[].ruleTupleCount
    (deprecated)

    integer

    [Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.
    items.securityPolicies[].displayName
    (deprecated)

    string

    User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.securityPolicies[].shortName

    string

    User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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.securityPolicies[].parent

    string

    [Output Only] The parent of the security policy.
    items.securityPolicies[].region

    string

    [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
    items.warning

    object

    Informational warning which replaces the list of security 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.
    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.
    etag

    string
    unreachables[]

    string

    [Output Only] Unreachable resources.

    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.

    IAM Permissions

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

    • compute.securityPolicies.list

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