RuleService

SearchRules

Queries rules based on provided search parameters.

post/api/v1/rules/search

Request

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

Request body

limitinteger

Max number of rules to return (returns all if omitted).

offsetinteger

Only applies if limit provided.

order'SEARCH_ORDER_UNSPECIFIED' | 'SEARCH_ORDER_ASC' | 'SEARCH_ORDER_DESC'
nameMatchesstring
caseSensitiveboolean
regexpboolean
orderBystring

The field to sort results by. Valid values are created_date and modified_date. Defaults to created_date. Use order to set the sort direction.

ruleIdsstring[]
assetIdsstring[]
includeDeletedboolean

Response

A successful response.

countinteger required

Changes

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