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/{regex_property_id}

Retrieves a flow regex property based on the supplied regex property ID.

Retrieves a flow regex property based on the supplied regex property ID.

Table 1: GET /config/flow_sources/custom_properties/regex_properties/{regex_property_id} Resource Details

MIME Type

application/json

Table 2: GET /config/flow_sources/custom_properties/regex_properties/{regex_property_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

regex_

property_id

path

Required

Number (Integer)

text/plain

Required - The sequence ID of the flow_regex_property.

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.

Table 3: GET /config/flow_sources/custom_properties/regex_properties/{regex_property_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested flow regex property was successfully retrieved.

404

1002

The requested flow regex property cannot be found.

500

1020

An error occurred during the attempt to retrieve the requested flow regex property.

Response Description

A flow regex property that 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