POST /analytics/custom_actions/actions/{action_id}

Updates an existing custom action.

Updates an existing custom action. The custom action should contain the following fields:

id - Required - Number - Unique ID of the custom action within the QRadar deployment.
name - Optional - String - Unique name of the custom action within the QRadar deployment.
description - Optional - String - Description of the custom action.
interpreter - Required - Number - Unique ID of the custom action interpreter used by the custom action.
script - Required - Number - Unique ID of the custom action script used by the custom action.
parameters - Required - Array - Array of custom action parameters contained within the custom action. Each Custom action parameter must have the following fields:
- name - Required - String - Name of the custom action parameter. Unique in the context of the parent custom action.
- parameter_type - Optional - String - Custom action parameter type. Can be either fixed or dynamic.
- encrypted - Optional - Boolean - Designates whether the custom action parameter value field is stored in an encrypted state.True if encrypted, false otherwise.
- value - Optional - String - Value of the custom action parameter. Custom action parameters with parameter_type fixed can have any value. Custom action parameters with parameter_type dynamic must have values corresponding to column names in an Ariel database, for example sourceip. Ariel database column names are available through the /api/ariel/databases/{database_name} endpoint.

Table 1. POST /analytics/custom_actions/actions/{action_id} resource details
MIME Type
application/json

Table 2. POST /analytics/custom_actions/actions/{action_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
action_id	path	Required	Number (Integer)	text/plain	Number id of the custom action to be updated.
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 /analytics/custom_actions/actions/{action_id} request body details
Parameter	Data Type	MIME Type	Description	Sample
custom_action	Object	application/json	Custom action JSON object which can contain the supplied fields (see above for more details).	{ "description": "String", "id": 42, "interpreter": 42, "name": "String", "parameters": [ { "encrypted": true, "name": "String", "parameter_type": "String", "value": "String" } ], "script": 42 }

Table 4. POST /analytics/custom_actions/actions/{action_id} response codes
HTTP Response Code	Unique Code	Description
200		The custom action has been updated.
404	1002	The requested custom action could not be found.
422	1005	One or more parameters are invalid in request.
500	1020	An internal server error occurred while updating custom action with supplied action_id.

Response Description

The updated custom action with the following fields:

id - Number - Unique ID of the custom action within the QRadar deployment.
name - String - Unique name of the custom action within the QRadar deployment.
description - String - Optional description attached to the custom action.
interpreter - Number - Unique ID of the custom action interpreter used by the custom action.
script - Number - Unique ID of the custom action script used by the custom action.
parameters - Array - Array of custom action parameters contained within the custom action. Each Custom action parameter has the following fields:
- name - String - Name of the custom action parameter. Unique in the context of the parent custom action.
- parameter_type - String - Custom action parameter type. Can be either fixed or dynamic.
- encrypted - Boolean - Designates whether the custom action parameter value field is stored in an encrypted state.True if encrypted, false otherwise.
- value - String - Value of the custom action parameter.

Response Sample


{
    "description": "String",
    "id": 42,
    "interpreter": 42,
    "name": "String",
    "parameters": [
        {
            "encrypted": true,
            "name": "String",
            "parameter_type": "String",
            "value": "String"
        }
    ],
    "script": 42
}