Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /analytics/rules

Retrieves a list of rules.

Retrieves a list of rules

Table 1: GET /analytics/rules Resource Details

MIME Type

application/json

Table 2: GET /analytics/rules Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /analytics/rules Response Codes

HTTP Response Code

Unique Code

Description

200

 

The rules were retrieved.

422

1010

A request parameter is not valid.

500

1020

An error occurred during the attempt to retrieve the rules.

Response Description

An array of rule objects. A rule object contains the following fields:

  • id - Long - The sequence ID of the rule.

  • name - String - The name of the rule.

  • type - String - The type of rule: EVENT, FLOW, COMMON, USER.

  • enabled - Boolean - True if the rule is enabled.

  • owner - String - The owner of the rule.

  • origin - String - The origin of the rule: SYSTEM, OVERRIDE, USER.

  • base_capacity - Long - The base capacity of the rule in events per second.

  • base_host_id - Long - The ID of the host from which the rule's base capacity was determined

  • average_capacity - Long - The moving average capacity, in EPS, of the rule across all hosts.

  • capacity_timestamp - Long - The epoch timestamp, in milliseconds, since the rule's capacity values were last updated.

  • identifier - String - The unique ID of the rule. This value is typically in the form of a UUID, with the exception of legacy system rules.

  • linked_rule_identifier - String - The linked ID of the rule. This value is typically in the form of a UUID, with the exception of legacy system rules, and varies depending on the rule's origin as follows:

    • SYSTEM - The identifier value of the override rule, if one exists. If the system rule has not been overridden, the value will be null.

    • OVERRIDE - The identifier value of the system rule being overridden.

    • USER - The value will be null.

  • creation_date - Long - The number of milliseconds since epoch when the rule was created.

  • modification_date - Long - The number of milliseconds since epoch when the rule was last modified.

Response Sample