ON THIS PAGE
GET /config/event_sources/custom_properties/property_expressions
SUMMARY Retrieves a list of event regex property expressions.
Retrieves a list of event regex property expressions.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The requested list of event regex property expressions was retrieved. |
|
422 |
1010 |
An error occurred while building the filter. |
500 |
1020 |
An error occurred during the attempt to retrieve the list of event regex property expressions. |
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" } ]