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/{regex_property_id}

Retrieves a event regex property based on the supplied regex property ID.

Retrieves a event regex property based on the supplied regex property ID.

Table 1: GET /config/event_sources/custom_properties/regex_properties/{regex_property_id} Resource Details

MIME Type

application/json

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

Parameter

Type

Optionality

Data Type

MIME Type

Description

regex_property_id

path

Required

String

text/plain

Required - The identifier of the event_regex_property.

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/{regex_property_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested event regex property was successfully retrieved.

404

1002

The requested event regex property cannot be found.

500

1020

An error occurred during the attempt to retrieve the requested event regex property.

Response Description

A event regex property that 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 the 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 the locale that the property matches.

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

Response Sample