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

Updates an existing event regex property.

Updates an existing event regex property.

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

MIME Type

application/json

Table 2: POST /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

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/regex_properties/{regex_property_id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

data

Object

application/json

Required - A JSON representation of the event regex property object.

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

  • property_type - Optional - String - The property type (string, numeric, ip, port, time) of event regex property.

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

  • datetime_format - Optional - String - The date/time pattern that the event regex property matches. It is required when property type is TIME.

  • locale - Optional - String - The language tag of the locale that the property matches. The locale is required when the property type is TIME.

  • username - Optional - String - The owner of the event regex property. If the input username is authorized service, the prefix "API_token: " is required.

{ "creation_date": 42, "datetime_format": "String", "description": "String", "id": 42, "identifier": "String", "locale": "String", "modification_date": 42, "name": "String", "property_type": "String <one of: string, numeric, ip, port, time>", "use_for_rule_engine": true, "username": "String" }

Table 4: POST /config/event_sources/custom_properties/regex_properties/{regex_property_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The event regex property was updated.

403

1009

The user cannot update the resource because it only can be updated by the owner or admin user.

404

1002

The requested event regex property cannot be found.

422

1005

One or more parameters are invalid in request.

500

1020

An error occurred during the attempt to update an event regex property.

Response Description

The updated event regex property object 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 the locale the the property matches.

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

Response Sample