-
Notifications
You must be signed in to change notification settings - Fork 1
/
17.0--analytics-custom_actions-scripts-POST.html
234 lines (159 loc) · 8.87 KB
/
17.0--analytics-custom_actions-scripts-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
<!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 2023">
<meta name="description" content="Creates a new custom action script file. Newly created custom action script files require a deployment before using.">
<meta name="keywords" content="/analytics/custom_actions/scripts, 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_version170_analytics_intro.html">
<title>POST /analytics/custom_actions/scripts</title>
</head>
<body id="api-17.0--analytics-custom_actions-scripts-POST"><main role="main"><article role="article" aria-labelledby="api-17.0--analytics-custom_actions-scripts-POST__title__1">
<h1 class="topictitle1" id="api-17.0--analytics-custom_actions-scripts-POST__title__1">POST /analytics/custom_actions/scripts</h1>
<div class="body refbody"><p class="shortdesc">Creates a new custom action script file. Newly created custom action script files require a deployment before using.</p>
<div class="section refsyn">
<p>Creates a new custom action script file. Newly created custom action script files require a deployment before using.
Users can include an <em>optional</em> HTTP header <strong>file_name</strong> containing the custom action script file name. If not specified this is defaulted to the script id of the uploaded file.</p>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/custom_actions/scripts resource details" class="defaultstyle"><caption><span class="tablecap">Table 1. POST /analytics/custom_actions/scripts resource details</span></caption><colgroup><col style="width:100%"></colgroup><thead style="text-align:left;">
<tr style="vertical-align:bottom;">
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__1" class="thbot">MIME Type</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__1 "><p>application/json
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/custom_actions/scripts request parameter details" class="defaultstyle"><caption><span class="tablecap">Table 2. POST /analytics/custom_actions/scripts 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="api-17.0--analytics-custom_actions-scripts-POST__entry__3" class="thbot">Parameter</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__4" class="thbot">Type</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__5" class="thbot">Optionality</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__6" class="thbot">Data Type</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__7" class="thbot">MIME Type</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__8" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__3 "><p>fields</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__4 "><p>header</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__5 "><p>Optional</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__6 "><p>String</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__7 "><p>text/plain</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__8 "><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/scripts request body details" class="defaultstyle"><caption><span class="tablecap">Table 3. POST /analytics/custom_actions/scripts 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="api-17.0--analytics-custom_actions-scripts-POST__entry__15" class="thbot">Parameter</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__16" class="thbot">Data Type</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__17" class="thbot">MIME Type</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__18" class="thbot">Description</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__19" class="thbot">Sample</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__15 "><p>file</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__16 "><p>File</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__17 "><p>application/octet-stream</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__18 "><p><em>Required</em>. The custom action script file. Must be supplied with MIME type <em>application/octet-stream</em>.</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__19 "><p>File</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section refsyn">
<div class="tablenoborder"><table summary="POST /analytics/custom_actions/scripts response codes" class="defaultstyle"><caption><span class="tablecap">Table 4. POST /analytics/custom_actions/scripts 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="api-17.0--analytics-custom_actions-scripts-POST__entry__25" class="thbot">HTTP Response Code</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__26" class="thbot">Unique Code</th>
<th id="api-17.0--analytics-custom_actions-scripts-POST__entry__27" class="thbot">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__25 "><p>201</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__26 "><p></p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__27 "><p>A custom action script file has been created.</p>
</td>
</tr>
<tr>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__25 "><p>500</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__26 "><p>1020</p>
</td>
<td headers="api-17.0--analytics-custom_actions-scripts-POST__entry__27 "><p>An internal server error occurred while posting custom action script file.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<section class="section refsyn" role="region" aria-labelledby="api-17.0--analytics-custom_actions-scripts-POST__title__6"><h2 class="sectiontitle" id="api-17.0--analytics-custom_actions-scripts-POST__title__6">Response Description</h2>
<div class="p">Custom action script file meta-data with the following fields:
<ul>
<li><strong>id</strong> - Number - Unique ID of the custom action script within the QRadar deployment.</li>
<li><strong>name</strong> - String - Name of the custom action script.</li>
</ul>
</div>
</section>
<section class="section refsyn" role="region" aria-labelledby="api-17.0--analytics-custom_actions-scripts-POST__title__7"><h2 class="sectiontitle" id="api-17.0--analytics-custom_actions-scripts-POST__title__7">Response Sample</h2>
<pre class="codeblock"><code>
{
"file_name": "String",
"id": 42
}
</code></pre>
</section>
</div>
<aside role="complementary" aria-labelledby="api-17.0--analytics-custom_actions-scripts-POST__title__1"><nav role="navigation">
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="c_rest_api_version170_analytics_intro.html" title="Use the references for REST API 17.0 analytics endpoints.">analytics endpoints</a></div>
</div>
</nav></aside></article></main></body></html>