Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /config/event_sources/custom_properties/regex_properties

 

Retrieves a list of event regex properties.

Retrieves a list of event regex properties.

Table 1: GET /config/event_sources/custom_properties/regex_properties Resource Details

MIME Type

application/json

Table 2: GET /config/event_sources/custom_properties/regex_properties Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

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.

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.

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/regex_properties Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested list of event regex properties was retrieved.

422

1010

An error occurred while building the filter.

500

1020

An error occurred during the attempt to retrieve the list of event regex properties.

Response Description

A list of event regex properties. Each regex property contains the following fields:

  • id - Integer - The sequence ID of the event regex property.

  • identifier - String - The ID of the event regex property.

  • name - String - The name of the event regex property.

  • username - String - The owner of the event regex property.

  • description - String - The description of the event regex property.

  • property_type - String - The property type (STRING, NUMERIC, IP, PORT, TIME) of event regex property.

  • use_for_rule_engine - Boolean - The flag to indicate if the event regex property is parsed when the event is received.

  • datetime_format - String - The date/time pattern that the event regex property matches.

  • locale - String - The Language tag of what locale the Property matches.

  • auto_discovered - Boolean - The flag to indicate if the event regex property is generated by custom properties discovery engine.

Response Sample