GET /analytics/custom_actions/scripts/{script_id}

Retrieves meta-data of a custom action script file based on supplied script_id.

Retrieves meta-data of a custom action script file based on supplied script_id.

Table 1. GET /analytics/custom_actions/scripts/{script_id} resource details
MIME Type

application/json

Table 2. GET /analytics/custom_actions/scripts/{script_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

script_id

path

Required

Number (Integer)

text/plain

Number id of the custom action script file.

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 /analytics/custom_actions/scripts/{script_id} response codes
HTTP Response Code Unique Code Description

200

The requested custom action script file has been retrieved.

404

1002

The requested custom action script file could not be found.

500

1020

An internal server error occurred while retrieving custom action script file meta-data with supplied script_id.

Response Description

Custom action script file meta-data with the following fields:
  • id - Number - Unique ID of the custom action script file within the QRadar deployment.
  • name - String - Name of the custom action script file.

Response Sample


{
    "file_name": "String",
    "id": 42
}