-
Notifications
You must be signed in to change notification settings - Fork 0
/
12.0--analytics-custom_actions-actions-POST.html
315 lines (218 loc) · 10.2 KB
/
12.0--analytics-custom_actions-actions-POST.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<!DOCTYPE html><html lang="en-us">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<meta name="dcterms.rights" content="© Copyright IBM Corporation 2022">
<meta name="description" content="Creates a new custom action with the supplied fields.">
<meta name="keywords" content="/analytics/custom_actions/actions, POST, API, REST API">
<meta name="geo.country" content="ZZ">
<script>
digitalData = {
page: {
pageInfo: {
language: "en-us",
version: "v18",
ibm: {
country: "ZZ",
type: "CT701"
}
}
}
};
</script><!-- Licensed Materials - Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="ibmdita.css">
<link rel="Start" href="c_rest_api_version120_analytics_intro.html">
<title>POST /analytics/custom_actions/actions</title>
</head>
<body id="api-12.0--analytics-custom_actions-actions-POST"><main role="main"><article role="article" aria-labelledby="d117345e10">
<h1 class="topictitle1" id="d117345e10">POST /analytics/custom_actions/actions</h1>
<div class="body refbody"><p class="shortdesc">Creates a new custom action with the supplied fields.</p>
<div class="section refsyn">
<div class="p">Creates a new custom action with the supplied fields. The custom action must contain the following fields:
<ul>
<li><strong>name</strong> - <em>Required</em> - String - Unique name of the custom action within the QRadar deployment.</li>
<li><strong>description</strong> - <em>Optional</em> - String - Description of the custom action.</li>
<li><strong>interpreter</strong> - <em>Required</em> - Number - Unique ID of the custom action interpreter used by the custom action.</li>
<li><strong>script</strong> - <em>Required</em> - Number - Unique ID of the custom action script used by the custom action.</li>
<li><strong>parameters</strong> - <em>Required</em> - Array - Array of custom action parameters contained within the custom action. Each Custom action parameter must have the following fields:
<ul>
<li><strong>name</strong> - <em>Required</em> - String - Name of the custom action parameter. Unique in the context of the parent custom action.</li>
<li><strong>parameter_type</strong> - <em>Required</em> - String - Custom action parameter type. Can be either <em>fixed</em> or <em>dynamic</em>.</li>
<li><strong>encrypted</strong> - <em>Required</em> - Boolean - Designates whether the custom action parameter value field is stored in an encrypted state.<em>True</em> if encrypted, <em>false</em> otherwise.</li>
<li><strong>value</strong> - <em>Required</em> - String - Value of the custom action parameter. Custom action parameters with parameter_type <em>fixed</em> can have any value.
Custom action parameters with parameter_type <em>dynamic</em> must have values corresponding to column names in an Ariel database, for example <em>sourceip</em>.
Ariel database column names are available through the <em>/api/ariel/databases/{database_name}</em> endpoint.</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/custom_actions/actions resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. POST /analytics/custom_actions/actions resource details</span></caption><colgroup><col style="width:100%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d117345e165" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d117345e165 "><p>application/json
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/custom_actions/actions request parameter details" class="defaultstyle"><caption><span class="tablecap">Table 2. POST /analytics/custom_actions/actions request parameter details</span></caption><colgroup><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:28.57142857142857%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d117345e213" class="thbot">Parameter</th>
<th id="d117345e216" class="thbot">Type</th>
<th id="d117345e219" class="thbot">Optionality</th>
<th id="d117345e222" class="thbot">Data Type</th>
<th id="d117345e225" class="thbot">MIME Type</th>
<th id="d117345e229" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d117345e213 "><p>fields</p>
</td>
<td headers="d117345e216 "><p>header</p>
</td>
<td headers="d117345e219 "><p>Optional</p>
</td>
<td headers="d117345e222 "><p>String</p>
</td>
<td headers="d117345e225 "><p>text/plain</p>
</td>
<td headers="d117345e229 "><p>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.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/custom_actions/actions request body details" class="defaultstyle"><caption><span class="tablecap">Table 3. POST /analytics/custom_actions/actions request body details</span></caption><colgroup><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:14.285714285714285%"><col style="width:28.57142857142857%"><col style="width:28.57142857142857%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d117345e296" class="thbot">Parameter</th>
<th id="d117345e299" class="thbot">Data Type</th>
<th id="d117345e302" class="thbot">MIME Type</th>
<th id="d117345e305" class="thbot">Description</th>
<th id="d117345e308" class="thbot">Sample</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d117345e296 "><p>custom_action</p>
</td>
<td headers="d117345e299 "><p>Object</p>
</td>
<td headers="d117345e302 "><p>application/json</p>
</td>
<td headers="d117345e305 "><p>Custom action JSON object containing the supplied fields (see above for more details).</p>
</td>
<td headers="d117345e308 "><p>{
"description": "String",
"interpreter": 42,
"name": "String",
"parameters": [
{
"encrypted": true,
"name": "String",
"parameter_type": "String",
"value": "String"
}
],
"script": 42
}</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/custom_actions/actions response codes" class="defaultstyle"><caption><span class="tablecap">Table 4. POST /analytics/custom_actions/actions response codes</span></caption><colgroup><col style="width:20%"><col style="width:20%"><col style="width:60%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="d117345e365" class="thbot">HTTP Response Code</th>
<th id="d117345e368" class="thbot">Unique Code</th>
<th id="d117345e371" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="d117345e365 "><p>201</p>
</td>
<td headers="d117345e368 "><p></p>
</td>
<td headers="d117345e371 "><p>A new custom action has been successfully created.</p>
</td>
</tr>
<tr>
<td headers="d117345e365 "><p>422</p>
</td>
<td headers="d117345e368 "><p>1005</p>
</td>
<td headers="d117345e371 "><p>One or more parameters are invalid in request.</p>
</td>
</tr>
<tr>
<td headers="d117345e365 "><p>500</p>
</td>
<td headers="d117345e368 "><p>1020</p>
</td>
<td headers="d117345e371 "><p>An internal server error occurred while posting custom action.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="d117345e429"><h2 class="sectiontitle" id="d117345e429">Response Description</h2>
<div class="p">The newly created custom action with the following fields:
<ul>
<li><strong>id</strong> - Number - Unique ID of the custom action within the QRadar deployment.</li>
<li><strong>name</strong> - String - Unique name of the custom action within the QRadar deployment.</li>
<li><strong>description</strong> - String - Optional description attached to the custom action.</li>
<li><strong>interpreter</strong> - Number - Unique ID of the custom action interpreter used by the custom action.</li>
<li><strong>script</strong> - Number - Unique ID of the custom action script used by the custom action.</li>
<li><strong>parameters</strong> - Array - Array of custom action parameters contained within the custom action. Each Custom action parameter has the following fields:
<ul>
<li><strong>name</strong> - String - Name of the custom action parameter. Unique in the context of the parent custom action.</li>
<li><strong>parameter_type</strong> - String - Custom action parameter type. Can be either <em>fixed</em> or <em>dynamic</em>.</li>
<li><strong>encrypted</strong> - Boolean - Designates whether the custom action parameter value field is stored in an encrypted state.<em>True</em> if encrypted, <em>false</em> otherwise.</li>
<li><strong>value</strong> - String - Value of the custom action parameter.</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="section refsyn" role="region" aria-labelledby="d117345e506"><h2 class="sectiontitle" id="d117345e506">Response Sample</h2>
<pre class="codeblock"><code>
{
"description": "String",
"id": 42,
"interpreter": 42,
"name": "String",
"parameters": [
{
"encrypted": true,
"name": "String",
"parameter_type": "String",
"value": "String"
}
],
"script": 42
}
</code></pre>
</section>
</div>
<aside role="complementary" aria-labelledby="d117345e10"><nav role="navigation">
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="c_rest_api_version120_analytics_intro.html" title="Use the references for REST API 12.0 analytics endpoints.">Analytics endpoints</a></div>
</div>
</nav></aside></article></main></body></html>