POST /config/event_sources/custom_properties/property_cef_expressions

Creates a new CEF expression.

Creates a new CEF expression.

Table 1. POST /config/event_sources/custom_properties/property_cef_expressions resource details
MIME Type

application/json

Table 2. POST /config/event_sources/custom_properties/property_cef_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_cef_expressions request body details
Parameter Data Type MIME Type Description Sample

data

Object

application/json

Required - A JSON representation of the CEF 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.
  • expression - Required - String - The CEF expression path to find the property value from the CEF payload.
  • payload - Optional - 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 - 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.

{ "creation_date": 42, "enabled": true, "expression": "String", "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_property_identifier": "String", "username": "String" }

Table 4. POST /config/event_sources/custom_properties/property_cef_expressions response codes
HTTP Response Code Unique Code Description

201

A new CEF 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 CEF expression.

Response Description

The newly created CEF expression that contains the following fields:
  • id - Integer - The sequence ID of the CEF expression.
  • identifier - String - The unique ID of the CEF expression. This value is in the form of a UUID.
  • regex_property_identifier - String - The identifier of event the regex property to which this expression belongs.
  • enabled - Boolean - Flag that indicates whether this expression is enabled.
  • expression - String - The CEF expression path to find the property value from the CEF payload.
  • 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 CEF expression.

Response Sample


{
    "creation_date": 42,
    "enabled": true,
    "expression": "String",
    "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_property_identifier": "String",
    "username": "String"
}