Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /config/event_sources/custom_properties/property_expressions

Creates a new event regex property expression.

Creates a new event regex property expression.

Table 1: POST /config/event_sources/custom_properties/property_expressions Resource Details

MIME Type

application/json

Table 2: POST /config/event_sources/custom_properties/property_expressions Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

fields

header

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: POST /config/event_sources/custom_properties/property_expressions Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

data

Object

application/json

Required - A JSON representation of the regex property expression object

  • regex_property_identifier - Required - String - The identifier of the event regex property that this expression belongs to.

  • enabled - Optional - Boolean - Flag that indicates whether this expression is enabled. It defaults to true if not provided.

  • regex - Required - String - The regex to extract the property from the payload.

  • capture_group - Optional - Integer - The capture group to capture. It defaults to 1 if not provided.

  • payload - Optional - String - Test payload. This parameter is only used in the UI so that the user can verify their regex matches the expected payload.

  • log_source_type_id - Required - Integer - The expression is only applied to events for this log source type.

  • log_source_id - Optional - Integer - The expression is only applied to events for this log source (more specific than type alone).

  • qid - Optional - Integer - The expression is only applied to events associated with this QID record.

  • low_level_category_id - Optional - Integer - The expression is only applied to events with this low level category.

{ "capture_group": 42, "creation_date": 42, "enabled": true, "id": 42, "identifier": "String", "log_source_id": 42, "log_source_type_id": 42, "low_level_category_id": 42, "modification_date": 42, "payload": "String", "qid": 42, "regex": "String", "regex_property_identifier": "String", "username": "String" }

Table 4: POST /config/event_sources/custom_properties/property_expressions Response Codes

HTTP Response Code

Unique Code

Description

201

 

A new event regex property expression was created.

422

1005

One or more request parameter are invalid in request.

500

1020

An error occurred during the attempt to create a new event regex property expression.

Response Description

The newly created event regex property expression that contains the following fields:

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

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

  • regex_property_identifier - String - The identifier of the event regex property that this expression belongs to.

  • enabled - Boolean - Flag that indicates whether this expression is enabled.

  • regex - String - The regex to extract the property from the payload.

  • capture_group - Integer - The capture group to capture.

  • payload - String - Test payload. This parameter is only used in the UI so that the user can verify their regex 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 event regex property expression.

Response Sample