POST /config/flow_sources/custom_properties/regex_properties/{regex_property_id}

Updates an existing flow regex property.

Table 1. POST /config/flow_sources/custom_properties/regex_properties/{regex_property_id} resource details
MIME Type
application/json

Table 2. POST /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	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/flow_sources/custom_properties/regex_properties/{regex_property_id} request body details
Parameter	Data Type	MIME Type	Description	Sample
data	Object	application/json	Required - A JSON representation of the flow regex property object. description - Optional - String - The description of the flow regex property. property_type - Optional - String - The property type (string, numeric, ip, port, time) of flow regex property. use_for_rule_engine - Optional - Boolean - The flag that indicates if the flow regex property is parsed when the flow is captured. It is false if no value supplied. datetime_format - Optional - String - The date/time pattern that the flow regex property matches. It is required when property type is TIME. locale - Optional - String - The language tag of the locale that the property matches.The locale is required when property type is TIME. username - Optional - String - The owner of the event regex property. If the input username is authorized service, the prefix "API_token: " is required.	{ "creation_date": 42, "datetime_format": "String", "description": "String", "id": 42, "identifier": "String", "locale": "String", "modification_date": 42, "name": "String", "property_type": "String <one of: string, numeric, ip, port, time>", "use_for_rule_engine": true, "username": "String" }

Table 4. POST /config/flow_sources/custom_properties/regex_properties/{regex_property_id} response codes
HTTP Response Code	Unique Code	Description
200		The flow regex property 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 flow regex property cannot be found.
422	1005	One or more parameters are invalid in the request.
500	1020	An error occurred during the attempt to update an flow regex property.

Response Description

The updated flow regex property object 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 is 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


{
    "creation_date": 42,
    "datetime_format": "String",
    "description": "String",
    "id": 42,
    "identifier": "String",
    "locale": "String",
    "modification_date": 42,
    "name": "String",
    "property_type": "String <one of: string, numeric, ip, port, time>",
    "use_for_rule_engine": true,
    "username": "String"
}