Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/flow_sources/custom_properties/regex_properties

SUMMARY Retrieves a list of flow regex properties.

Retrieves a list of flow regex properties.

Table 1: GET /config/flow_sources/custom_properties/regex_properties resource details:

GET /config/flow_sources/custom_properties/regex_properties resource details

MIME Type

application/json

Table 2: GET /config/flow_sources/custom_properties/regex_properties request parameter details:

GET /config/flow_sources/custom_properties/regex_properties request parameter details

Parameter Type Optionality Data Type MIME Type Description

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.

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.

Table 3: GET /config/flow_sources/custom_properties/regex_properties response codes:

GET /config/flow_sources/custom_properties/regex_properties response codes

HTTP Response Code Unique Code Description

200

The requested list of flow regex properties was retrieved.

422

1010

An error occurred while building the filter.

500

1020

An error occurred during the attempt to retrieve the list of flow regex properties.

Response Description

A list of flow regex properties. Each regex property contains the following fields:
  • id - Integer - The sequence ID of the flow regex property.
  • identifier - String - The ID of the flow regex property.
  • name - String - The name of the flow regex property.
  • username - String - The owner of the flow regex property.
  • description - String - The description of the flow regex property.
  • property_type - String - The property type (string, numeric, ip, port, time) of flow regex property.
  • use_for_rule_engine - Boolean - The flag that indicates if the flow regex property is parsed when the flow was captured.
  • datetime_format - String - The date/time pattern that the flow regex property matches.
  • locale - String - The language tag of the locale that the property matches.
.

Response Sample