ON THIS PAGE
POST /config/event_sources/custom_properties/property_expressions/{expression_id}
SUMMARY Updates an existing event regex property expression.
Updates an existing event regex property expression.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
expression_id |
path |
Required |
String |
text/plain |
Required - The identifier of the event regex property expression. |
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 expression object.
|
{ "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" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The event regex property expression 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 expression 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 expression. |
Response Description
- id - Integer - The sequence ID of the event regex property expression.
- identifier - String - The unique ID of the event regex property expression. This value is typically in the form of a UUID, with the exception of some legacy event regex property expressions.
- regex_property_identifier - String - The identifier of the event regex property to which this expression belongs.
- 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 you can verify that your expression 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
{ "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" }