RuleService

ListRules

Retrieves a list of rules.

get/api/v1/rules:list

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/rules:list
  • Auth: HTTP bearer

Query parameters

pageSizeinteger

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

pageTokenstring

A page token, received from a previous ListRules call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRules must match the call that provided the page token.

filterstring

Optional. A Common Expression Language (CEL) filter string. Available fields: rule_id, client_key, name, description, is_external, asset_id, tag_id, created_date, created_by_user_id, metadata, modified_date, modified_by_user_id, deleted_date, is_archived, archived_date, and is_live_evaluation_enabled.

asset_id matches any Rule that has the given Asset among its configured Assets, not only Rules scoped exclusively to that Asset.

Metadata fields: use metadata.{metadata_key_name} as the field name.

Folder membership is filterable via the folders and activeFolders fields. Both contain the IDs of the folders the Rule belongs to; activeFolders excludes archived folders. Use "<folder_id>" in folders to return Rules in the given folder, and size(activeFolders) == 0 to return uncategorized Rules (Rules whose only memberships are in archived folders count as uncategorized).

For further information about how to use CEL, refer to this guide.

orderBystring

How to order the retrieved Rules. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date and modified_date. If left empty, items are ordered by created_date in descending order (newest-first).

Response

A successful response.

nextPageTokenstring

Changes

No recorded changes to this operation across all 1 revision of this API.