Method: securityPolicies.listPreconfiguredExpressionSets

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

HTTP request

GET https://www.googleapis.com/compute/beta/projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

number (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. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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.

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).

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.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "preconfiguredExpressionSets": {
    "wafRules": {
      "expressionSets": [
        {
          "id": string,
          "aliases": [
            string
          ],
          "expressions": [
            {
              "id": string
            }
          ]
        }
      ]
    }
  }
}
Fields
preconfiguredExpressionSets

object

preconfiguredExpressionSets.wafRules

object

preconfiguredExpressionSets.wafRules.expressionSets[]

object

globalOperations.list of entities that are currently supported for WAF rules.

preconfiguredExpressionSets.wafRules.expressionSets[].id

string

Google specified expression set ID. The format should be: - E.g. XSS-20170329 required

preconfiguredExpressionSets.wafRules.expressionSets[].aliases[]

string

A list of alternate IDs. The format should be: -<stable | canary | beta> E.g. XSS-stable Generic suffix like "stable" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set.

preconfiguredExpressionSets.wafRules.expressionSets[].expressions[]

object

globalOperations.list of available expressions.

preconfiguredExpressionSets.wafRules.expressionSets[].expressions[].id

string

Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. required

Authorization Scopes

Requires one of the following OAuth scopes:

  • 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 Google IAM permissions:

  • compute.securityPolicies.list
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine