Method: rules.list

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

Lists Rules.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1/{parent}/rules

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 previousrules.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided torules.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}"

orderBy

string

Optional. The sort order of the rules. If unspecified, rules will be sorted by revisionCreateTime desc ruleId asc. Sorting is supported on a single field only. Composite sort keys are not supported. Seehttps://google.aip.dev/132#ordering for more details.

Supported fields: "archived", "alertingEnabled", "author", "createTime", "displayName", "executionState", "liveModeEnabled", "revisionCreateTime", "ruleId", "ruleOwner", "severity", "type".

Example: "displayName desc"

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 aspageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see theAuthentication Overview.

IAM Permissions

Requires the followingIAM permission on theparent resource:

  • chronicle.rules.list

For more information, see theIAM documentation.

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

Last updated 2026-02-13 UTC.