Method: rules.list

Full name: projects.locations.instances.rules.list

Lists Rules.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of rules. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

The maximum number of rules to return. The service may return fewer than this value. If unspecified, at most 100 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous rules.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to rules.list must match the call that provided the page token.
view

enum (RuleView)

view indicates the scope of fields to populate for the Rule being returned. If unspecified, defaults to BASIC.
filter

string

Only the following filters are allowed: "referenceLists:{reference_list_name}" "dataTables:{data_table_name}" "displayName:{displayName}"

Request body

The request body must be empty.

Response body

Response message for rules.list method.

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

JSON representation 
{
  "rules": [
    {
      object (Rule)
    }
  ],
  "nextPageToken": string
}
Fields
rules[]

object (Rule)

The rules from the specified instance.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.rules.list

For more information, see the IAM documentation.