GET /analytics/custom_actions/actions

Retrieves a list of available custom actions.

Table 1. GET /analytics/custom_actions/actions resource details
MIME Type
application/json

Table 2. GET /analytics/custom_actions/actions 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 /analytics/custom_actions/actions response codes
HTTP Response Code	Unique Code	Description
200		The requested list of custom actions have been successfully retrieved.
500	1020	An internal server error occurred while retrieving custom actions.

Response Description

Array of available custom actions which in turn contain 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
    }
]