forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex-api-overview.html
388 lines (357 loc) · 18.4 KB
/
index-api-overview.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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Index endpoint | SIEM Guide [7.8] | Elastic</title>
<meta class="elastic" name="content" content="Index endpoint | SIEM Guide [7.8]">
<link rel="home" href="index.html" title="SIEM Guide [7.8]"/>
<link rel="up" href="rule-api-overview.html" title="Detections API"/>
<link rel="prev" href="bulk-actions-rules-api.html" title="Bulk rule actions"/>
<link rel="next" href="tags-api-overview.html" title="Tags endpoint"/>
<meta class="elastic" name="product_version" content="7.8"/>
<meta class="elastic" name="product_name" content="SIEM"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/SIEM/Guide/7.8"/>
<meta name="DC.subject" content="SIEM"/>
<meta name="DC.identifier" content="7.8"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.optimizely.com/js/18132920325.js"></script>
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<meta name="apple-mobile-web-app-title" content="Elastic">
<meta name="application-name" content="Elastic">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/mstile-144x144.png">
<meta name="theme-color" content="#ffffff">
<meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
<meta name="yandex-verification" content="d8a47e95d0972434" />
<meta name="localized" content="true" />
<meta name="st:robots" content="follow,index" />
<meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="172" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
<link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
<link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
<!-- Give IE8 a fighting chance -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/guide/static/styles.css" />
</head>
<!--© 2015-2022 Elasticsearch B.V. -->
<!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
<!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->
<body>
<!-- Google Tag Manager -->
<script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
<!-- End Google Tag Manager -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-12395217-16');
</script>
<!-- Google Tag Manager for GA4 -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager for GA4-->
<div id='elastic-nav' style="display:none;"></div>
<script src='https://www.elastic.co/elastic-nav.js'></script>
<div class="main-container">
<section id="content" >
<div class="content-wrapper">
<section id="guide" lang="en">
<div class="container-fluid">
<div class="row pb-3">
<div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
<!-- The TOC is appended here -->
</div>
<div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
<!-- start body -->
<div class="page_header">
The SIEM app is now a part of the Elastic Security solution.
<a href="../../../../en/security/current/index.html">Click
here</a> to view the current documentation.<br>
<b>IMPORTANT</b>: No additional bug fixes or documentation updates will be
released for this version.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="index.html">SIEM Guide [7.8]</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="siem-apis.html">SIEM APIs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="rule-api-overview.html">Detections API</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="bulk-actions-rules-api.html">« Bulk rule actions</a>
</span>
<span class="next">
<a href="tags-api-overview.html">Tags endpoint »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="index-api-overview"></a>Index endpoint<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h2>
</div></div></div>
<p>You use the index endpoint to create, get, and delete a signal index in a
Kibana space.</p>
<p>You can only create a signal index when the user role has <code class="literal">manage</code> privileges
for both the <a href="/guide/en/elasticsearch/reference/7.8/security-privileges.html" class="ulink" target="_top">Elasticsearch cluster and the
<code class="literal">.siem-signals-<Kibana space></code> index</a>.</p>
<p>When you create a signal index, the following
<a href="/guide/en/elasticsearch/reference/7.8/getting-started-index-lifecycle-management.html" class="ulink" target="_top">index lifecycle management (ILM)</a>
policy is created for the signal index:</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">{
"policy": {
"phases": {
"hot": {
"min_age": "0ms",
"actions": {
"rollover": {
"max_size": "50gb",
"max_age": "30d"
}
}
}
}
}
}</pre>
</div>
<p>The <code class="literal">policy</code> and <code class="literal">rollover_alias</code> use the same name as the signal index.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>To make sure administrators can always create indices, use a glob
pattern that matches indices from multiple spaces in the <code class="literal">Indices</code> field on
the <span class="strong strong"><strong>Create role</strong></span> page (<span class="strong strong"><strong>Management</strong></span> → <span class="strong strong"><strong>Roles</strong></span> → <span class="strong strong"><strong>Create role</strong></span>). For
example, <code class="literal">.siem-signals-*</code>.</p>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_create_index"></a>Create index<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h3>
</div></div></div>
<p>Creates a signal index. The naming convention for the index is
<code class="literal">.siem-signals-<space name></code>.</p>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="_request_url_9"></a>Request URL<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h4>
</div></div></div>
<p><code class="literal">POST <kibana host>:<port>/api/detection_engine/index</code></p>
<div class="section">
<div class="titlepage"><div><div>
<h5 class="title"><a id="_example_request_8"></a>Example request<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h5>
</div></div></div>
<p>Creates a signal index in the Kibana <code class="literal">siem</code> space.</p>
<div class="pre_wrapper lang-kibana">
<pre class="programlisting prettyprint lang-kibana">POST s/siem/api/detection_engine/index</pre>
</div>
<div class="kibana_widget" data-snippet="snippets/11.kibana"></div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="_response_code_9"></a>Response code<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h4>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">200</code>
</span>
</dt>
<dd>
Indicates a successful call.
</dd>
</dl>
</div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_get_index"></a>Get index<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h3>
</div></div></div>
<p>Gets the signal index name if it exists.</p>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="_request_url_10"></a>Request URL<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h4>
</div></div></div>
<p><code class="literal">GET <kibana host>:<port>/api/detection_engine/index</code></p>
<div class="section">
<div class="titlepage"><div><div>
<h5 class="title"><a id="_example_request_9"></a>Example request<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h5>
</div></div></div>
<p>Gets the signal index for the Kibana <code class="literal">siem</code> space:</p>
<div class="pre_wrapper lang-kibana">
<pre class="programlisting prettyprint lang-kibana">GET s/siem/api/detection_engine/index</pre>
</div>
<div class="kibana_widget" data-snippet="snippets/12.kibana"></div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="_response_code_10"></a>Response code<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h4>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">200</code>
</span>
</dt>
<dd>
Indicates a successful call.
</dd>
<dt>
<span class="term">
<code class="literal">404</code>
</span>
</dt>
<dd>
Indicates no index exists.
</dd>
</dl>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h5 class="title"><a id="_example_responses"></a>Example responses<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h5>
</div></div></div>
<p>Example response when index exists:</p>
<div class="pre_wrapper lang-json">
<pre class="programlisting prettyprint lang-json">{
"name": ".siem-signals-siem"
}</pre>
</div>
<p>Example response when no index exists:</p>
<div class="pre_wrapper lang-json">
<pre class="programlisting prettyprint lang-json">{
"statusCode": 404,
"error": "Not Found",
"message": "index for this space does not exist"
}</pre>
</div>
</div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_delete_index"></a>Delete index<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h3>
</div></div></div>
<p>Deletes the signal index.</p>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="_request_url_11"></a>Request URL<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h4>
</div></div></div>
<p><code class="literal">DELETE <kibana host>:<port>/api/detection_engine/index</code></p>
<div class="section">
<div class="titlepage"><div><div>
<h5 class="title"><a id="_example_request_10"></a>Example request<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h5>
</div></div></div>
<p>Deletes the signal index for the Kibana <code class="literal">siem</code> space:</p>
<div class="pre_wrapper lang-kibana">
<pre class="programlisting prettyprint lang-kibana">DELETE s/siem/api/detection_engine/index</pre>
</div>
<div class="kibana_widget" data-snippet="snippets/13.kibana"></div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h4 class="title"><a id="_response_code_11"></a>Response code<a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/stack-docs/edit/7.8/docs/en/siem/detections/api/index-api-overview.asciidoc">edit</a></h4>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">200</code>
</span>
</dt>
<dd>
Indicates a successful call.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="bulk-actions-rules-api.html">« Bulk rule actions</a>
</span>
<span class="next">
<a href="tags-api-overview.html">Tags endpoint »</a>
</span>
</div>
</div>
<!-- end body -->
</div>
<div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
<div id="sticky_content">
<!-- The OTP is appended here -->
<div class="row">
<div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
<div class="col-12 col-md-8 col-lg-12">
<div id="rtpcontainer">
<div class="mktg-promo" id="most-popular">
<p class="aside-heading">Most Popular</p>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">Get Started with Elasticsearch</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">Intro to Kibana</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div id='elastic-footer'></div>
<script src='https://www.elastic.co/elastic-footer.js'></script>
<!-- Footer Section end-->
</section>
</div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>