Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /config/event_sources/custom_properties/property_aql_expressions

SUMMARY Gets the list of Custom Property AQL Expressions. Requires the System Administrator, Security Admin or User Defined Event Properties permission.

Gets the list of Custom Property AQL Expressions. Requires the System Administrator, Security Admin or User Defined Event Properties permission.

Table 1: GET /config/event_sources/custom_properties/property_aql_expressions resource details:

GET /config/event_sources/custom_properties/property_aql_expressions resource details
MIME Type

application/json

Table 2: GET /config/event_sources/custom_properties/property_aql_expressions request parameter details:

GET /config/event_sources/custom_properties/property_aql_expressions 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 /config/event_sources/custom_properties/property_aql_expressions response codes:

GET /config/event_sources/custom_properties/property_aql_expressions response codes
HTTP Response Code Unique Code Description

200

The requested list of AQL expressions was retrieved.

422

1010

An error occurred while building the filter.

500

1020

An error occurred during the attempt to retrieve the list of AQL expressions.

Response Description

A list of AQL expressions. Each AQL expression contains the following fields:
  • id - Integer - The sequence ID of the AQL expression.
  • identifier - String - The unique ID of the AQL expression. This value is in the form of a UUID.
  • regex_property_identifier - String - The identifier of the event regex property to which this expression belongs.
  • enabled - Boolean - Flag that indicates whether this expression is enabled.
  • expression - String - The AQL expression used by the event property.
  • creation_date - Long - The epoch timestamp in milliseconds of the time the expression was created.
  • modification_date - Long - The epoch timestamp in milliseconds of the time the expression was last modified.
  • payload - String - Test payload. This parameter is only used in the UI so that you can verify that your expression matches the expected payload.
  • log_source_type_id - Integer - The expression is only applied to events for this log source type.
  • log_source_id - Integer - The expression is only applied to events for this log source (more specific than type alone).
  • qid - Integer - The expression is only applied to events associated with this QID record.
  • low_level_category_id - Integer - The expression is only applied to events with this low level category.
  • username - String - The owner of the AQL expression.

Response Sample