POST /config/event_sources/custom_properties/regex_properties
Creates a new event regex property.
Creates a new event regex property.
MIME Type |
---|
application/json |
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. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
data |
Object |
application/json |
Required - A JSON representation of the event regex property object.
|
{ "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" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
201 |
A new event regex property was created. |
|
422 |
1005 |
One or more request parameter are invalid in the request. |
500 |
1020 |
An error occurred during the attempt to create a new event regex property. |
Response Description
- 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 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
{
"auto_discovered": true,
"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"
}