forked from Shuffle/openapi-apps
-
Notifications
You must be signed in to change notification settings - Fork 0
/
insightidr_log_api.yaml
614 lines (598 loc) · 34.8 KB
/
insightidr_log_api.yaml
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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
basePath: /log_search
components:
securitySchemes:
ApiKeyAuth:
in: header
name: x-api-key
type: apiKey
host: eu.api.insight.rapid7.com
info:
contact:
email: frikky@shuffler.io
name: '@frikkylikeme'
url: https://twitter.com/frikkylikeme
description: InsightIDR API LOG, manipulate logs and Query
title: InsightIDR LOG API
version: '1.0'
x-categories:
- SIEM
x-logo: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAK4AAACuCAYAAACvDDbuAAAXJ0lEQVR4Xu2dd5xURbbHf7dz93SYGQYEEURBJPnBgLD6wQiYBZFdRUVAlCyLSBxUVARUwAFE95ERnnzA1bcsPlaMKKvPfagoLoiAYIIniBM6pxvqfaqHWcEldLi3u+7tuv/sjlSdW+ecb9etcOqUQAgh4A+3gM4sIHBwdeYx3tyUBTi4HARdWoCDq0u38UZzcDkDurQAB1eXbuON5uByBnRpAQ6uLt3GG83B5Qzo0gIcXF26jTeag8sZ0KUFOLi6dBtvNAeXM6BLC3Bwdek23mgOLmdAlxbg4OrSbbzRHFzOgC4twMHVpdt4ozm4nAFdWoCDq0u38UZzcDkDurQAB1eXbuON5uByBnRpAQ6uLt3GG83B5Qzo0gIcXF26jTeag8sZ0KUFOLi6dBtvNAeXM6BLC3Bwdek23mgOLmdAlxbg4OrSbbzRHFzOgC4twMHVpdt4ozm4nAFdWoCDq0u38UZzcDkDurRAwcBN7tsB5eeDEKwWXRou340WPGUQHE6YXB4IJT6Y3L58N4Gp9xUMXBIJwD93BJLbNgKCDCgCIACgdwCZAchH7dTwt3KSv+l/bqjX8P/p/5qOymj4N/p3ujJOJJO2o0FGg2zazgaZv61zMhkN7j9WFpXR8Pexuhwro+FuJGomdxnMTc6Dqbw5rG3awdS4FSzN28DcuAVMvjIINicgUEHGfQoGLjWpfOQgQiufRHL7e0c9Z1xDq66ZIgNEApQ4YHJAcHhhbt4clpadYWnTBbaOXWFp2hIw0V+X8Z6CggtCIB3ch8DTAyHXHDaskfODDQEozIIJEBQIdjts3frBec0fYG3TEYLFlp9m5OkthQX3qJLiN9tRN+1WQLFweNVyPL13UU6CSFHYLr0V7r7DYW7RAaYSTz3cOn+YAJfaMLFtM4ILRoAkRUAw5uetMKwQQIyAKHHYu/WDo3tf2Lv0gGB3FqY5Kr2VGXCJmETktfmIvr6Ij3dVcu6/iVEkCE4bbJ2vh/veSpgrztTqTZrLZQbc1GSt+hACcwdD+m4PYOLLZFp5n4gxCGYB3rFL4OjaC7BYtXqVZnKZApdqmfzqE/if6g3AZYixmGaey1UwoasSMpw974XrtlEwN26eq8S81mcOXCgKIhtXILxiEgRneV6NUXQvS03g4rC2vRglA6fD1vZC3az/sgduaswgofbRfpD2fQ5Y7EXHU94VVmSYPHZ4Ri2G/eIrj+7o5L0VGb2QTXBTqwzvITh/FIgo6aYXyMjyrBVWRJh8FfCOWQhbp8uYtzmz4CrhAELLH0XiH3RLmC+P5YVzOQmTrxHcD8yG49JrmV5TZxZcuquW2PEPBGcPAJH1v2CeF/DUeAldMnN74BlWBUfXnsz2vOyCS+NtJBGBqrFIfroBsOh7wVwNpvImg8gwNz0b3of+A9ZW7fP22kxexDS4VBHph92omXANBItLF5OGTIzPclkiRmHr0A2+8cth8rG3usM8uDRwxD9/LBIf/RmC3cuyr43XtmQY9iv6wztiFgQH7TjYedgHF4C4dxtqJ/aA4Kpgx3JF0hIS/h6e0S/BdcMApjTWBbhKsA6BBWMg7vxI261gcmxUOFN+yr4xqYDy3ILKTaUe+B5aDmvbi5iZrOkCXMgyIn9bgcgrc0B31jR5zDYI7kYQDBZ4TWJ+kFgwt+1zRYK9643wjpoLwVmiifkzFaoPcGkMw9efIVh1P5RwJFMdT19ekWA+uz28Q59lciJyegVOVkJA4PmxkPZuBcy57EASkGQYpZVrYO/SM/vmqFhTN+Aq9IzarAGQ9u9Uf0NCTsDetRe8o56H4HKraN7CipIOfIPayltSW+i5DhdA13fLz0LFc5sguDyFVYxqQwiNtNDHE16/DNHVEwFHI3UbTGS4eg+Fu/8UwGSczY7gkmmIv/UnwFaqjr0SNXDd/RTcfUcA5sKGneoK3NSa7oMdIbjPUccRDVLMZnjunwXnNf3UlVtAaXLNIdSMvRqQ6IkStX6MBKbyCpROWQNLizYF1E5nPS6JhVE97noQ/yEVnQGY3A74pr4K6zls7hJlQ0hkw1KEV05WPzRUAEr6T0HJrUNU9UGmOuqqx6XKBVfOROz1eRAcKn3+CIG5cTnKntoEU6kx1olJMo66x26A9MMB9ZevFBGW1p3ge3gZzBXNMuVNtfK6Aze56xPUVdLNiDPUMYKchK3zNSidsrzg4zZ1FAKSuz9HcN5QKMGAWiKPkUNSPwbf2IWwd7tRA/npidQduHS4cOSecyHY6cw2t4V1aiIS96NkwAy4+41Iz2Ksl5IlRF6rQuQvLwAmjXIpSDHYL/89fOMWFMwa+gNXTKLuiXsg7ftUlV00EjuE8jkfw3pe54I5Qc0XK8Fa+OcOhfT1VsDiUFP0cb0uif6EJmuPFGxpTHfg0jXJ4KJJiH+wDkhFjOXw0C1emwcVCzenAqiN8CR3bYV/5j2AXP9J1+oh8V/geWABXDcP1uoVp5SrP3CJgsj6hYisnZN7jyIlYel4Ncoff6mgM2Q1PR9cNBWxd5ZDsGm8SSAnYW7dBeVPrClIchEdgksQe/dlhJY+AphzG8PRXqNkwCy4+41Wk52CyVLqjqD24Z5QYuG8/BBJ/Gc0WrANlpZt866z/sClBym/2IJA1UhASuQ2QZPiKH381frDgQZ4Iq+vRPilyfmLW5bCcA9bAFevO3LzQxa21yW4yV2fIjBvFEi4NnuDEQWCpwLlM16D+YyWWZiOrSokHk3FJciHvs9Lb5vSnsiwX94H3uFP5324oEtwxW93IVA1DEo13UHLcgIiJ2Fp9zuUTVlhiMCa5M7/ReDZu0EktbZ30/hhEgJr6/bwjV8BU3mTNCqoV0SX4EqHvkewajikA/uyB1eMwHn9ILgHT4dgzW2srJ47spQkSwi/PBPRTavy19umelwCU2k5fOOX5X05UZfgKrWHEZg3DOI3NMQx2x6GwDP4cTivuzd7+LPkTO1qcvVPCFSNgLR/R95zIQg2B7yjq1JhoWpsCKVrG32CG6hBoGoQxD1fZR2bSy8A8Y5ZAHvn7unaitlyic/eRWD+g4As5hWeeoMQeAY9Duf1A3LoRDI3rT7BDfkRmDcU4q5tWRqLBtY0gm/SWljOap251ZiqQRBcMhXxt5cD1gKcgpYTcPUZCXf/yYA5fxmH9AluOIDg/BFI7vwku888UWBt0x6lU9cVbMtSLfYV/xHUjL8OJJLjubJsGyTFYe9+O7yjn4OQxzy7RQsuXQKzX9YnNcHQ8lEScTgvvwlWmsJTgyeycRXCKyZAsBfo3jM5AWvnniidtAiCNZdzbZkZpzjBpTZSJBAxnpm1silNkmj0wqewNFd/SEKvH6j541VQ6g5nPdbPRqXj6hAZpopWaDT3b3lNGqJPcIO1CDw3MKfJWc4OS0MAPRnr6DkEvpGz0iideZHEZ5sRmNkHcKgUm5x5E+q/WFIQjVfvh+DK3xhbv+BWDYG4+59ZTs6y8VCmdegQREbZ9A3arHHShIDPj0Ji6zuqhHdmqt2v5QlI+AiarDuYuqo1X48+wa39GYH5wyHuZRhcKQ5Lx+4oq1ypyXao9H/fIvDMXZB/qc5ugqoaYQQkcgRN1nJwT2tS6dAPCFY9AOnAfnZ7XDkB98BH4Lp5mPptJATxjzYgtLQSRKRrt4V8OLhpW1/87msE5o2AcuRggXubkzSZHsBs0iy1FWo5u13aeqVbkCQTCC2ZjPiWVxnIG8yHCun6Dcnd21L3QyiB6gLsFKXRTEWE/Yp+8I54VpO1TfnIAdRNuwOK/2f1e/M01Du+CAc3bZMlt29BgF5skqDLWVlGh6X9tiwKylF4x6+Coxvdv1f/SeVMWPVI/uJuT6kCBzdtD8c/3ojgC+M03zxIu0HHFqQJ9Jqeg7KZ62Fyq5T74Rj5JB5B7dTbIR/cDZhZuBGSg5seJ4Qg9uZLCK2clmMGwvRel2mp1CHC4S9qlgg5/sm7CDxzNyO9LbUOBzc9RhQZ4TUzEd3wImDV+EBgei36tVQqo2ELVFRtguDUJuujf8ZAJHf8vcBrt8cahgBKBI1X7uUbEKfiJXUTz4KxSG79b/Z63GQArn4T4L57cqbIp1Ve/P5rBGb0hRKhaUMZeejQqNl5KH9mA9/yPSW4yThqJ/aCfPgAQ71O/WkAwe1F6cRlsJ5/ifpUEYLoxiUIr50NEIYmpA1BNhMXQbDxIJuTOp5OTo7c1QyCozFbKwo0B9nFV8P74EKY3OpvfSohP4IvjELyiw/Z+tJIcTiuvgOe4dos/Z0MBN1t+Sa2bYb/yT4QSgoYWHIiaxIJJXdVoqTPcPV729TNQ1/AP2coSKiOrU0XRULJHQ+jpO/ovB4b0he4REF43QJEXpkBwVmmCSBZCaWHBr1e+KauhbWV+jtltE3hV+Yh+upswMrG5SH/spMAeO6fAee1d+b1B6UrcFO5A6b0hnxoH1PjWyLG4Oh+B7yjn9XkxDAdHtVMvh3K4T1M6U2XwgSnF16acjTPZ/d0Ba585CCqh7ZXLzduVt3rv1ci8TqUz/0A1tYXqCTxeDHJLz5A3fS+ENS++yLX1tIvTUVT+MYvhfWcDrlKy6i+rsCNf/wm/DP7wuRtnpGSmhaWYrC0vwpl01ZpEpdAl//8s+5DcscHEDRLG5qlhejZvQ5d4Bu3BCaP+ruEp2qVbsCtj4h6BPEtrwCW/C27nNalUhTeCSvh6Hb9aYtmUyC5dzv8038PSNqmDc2mbTQFk6PXEHgHV+Y9m7tuwJVp8PiM2yAd+iUrG2tSid6HcM6FKJ36EkxebSaLoeXTEHt7NWNj26PWFIPwjl8Nx2U3aGJeQ/S49HxV8MWHQCdozDw0p8Bto+C+c6ImPY7ir4Z/ziBI+3cV7jDkqYwtB9Hohc9hbnJW3l2ijx6X5sZ67XlE1y9kyoEmtxvesYtg6/Q7TRyX2L4FwYVjQKL0GliGdsuotlIc1ktuRun4hZqspJzOoLoAV6Epl54bDnEPvfeBhVA+erxdhrX9JfBNWK7JThmVH3r5aUQ3vADBpk3AzungONW/k/Ah+KZvguOiK3MRk3VdXYAr/bgbtRN6Hc1AzkbPQ5IReIbOheuGe7I2/inBiIVQ++gdkA98rckwJKdG09zCTg8ar/wyJzG5VGYfXEIQfvkZRNbPYycGlciA1YVGCzbDXK7N1nNi+4cIzOzPwJmyE+AlhuG8bSw8AypzYS+nusyDS6JBVI+5AiQSYuB81VFbJ0Nw3jYengETNdnmTN0MOXMIpK82A1bGhgk0Cs7lQumkFbC2uzQn+HKpzDy4kU1rEF48GoKTketK6WfS6kB51bswNz4zF9uftK64bwdqJ11buHxgp9JKkWG/tCc8I+fClMcEIL9tEtPg0kmZf+YgSD9mnwdXbbKIGIHjqrvgG1Oltuh6eYQgtGoWohv/BMHq1OYdOUgVLGa4h86G88o+OUjJvSrD4BLEtryO0OKHAJK/vKunNilJTZS8Y+bDodE9tnLtEfif6gf58E/sLYEpEiytO6N00jKYSmk8dOEeZsFVwgGEFk9E4tN32RnbUse1ap9aAtNqmBD7+18RXjIRhN4MydhDQj+hdPobsF90lSZj+0zUZRbc5D8/QmDuMBAxx7vMMrHG6coqSTh73QPPkJmAKdu7J07+EpKIIbSiEvH3XwPMWt3DezolT/zvNCWrrWsflE16MTsBKtdiE1yiILBgDBL/sz73+3pVNJhgAXyV62Dr0EVFqb+Kkn/+Ef5n7q+PNxZYGR7V32cmOF0om74elhb5v0XyRMZmEtzkrs/gf6I3YHIW/JPUYDQiJWDrfDVKJy7RJPsifU/8w78i8PxoCBbWJmUKSm4fC1ffUZqEbmbTCzAHLomFUT3hZpDqH/N6hul0xiOxapQ9vgE2Or7T6Kl9ciDEne9DYClsk8bctr4A3vGLYS5vqpHmmYtlC1xFRvTttQgtGg7B2SxzbbSqISdgPvtClD+1DoJDmzNf4v4dqJty49FYYza2tUEUQIjCN+nPsBcoJuFkLmUKXOnHvQjMH1l/Hy1D0VAkGYJn6By4bhio1U8DweXTEX/jRcDGSnYemiI/Ac/I+XBeczs7KztHPcAMuPQijsja2Yi+sZy5iYmp/EyUPboa5jPVv4CE+kGuOYy6yhuhhILs/GDFIFx9/wj3XZVMDdkaeg5mwJW++wp10/qCiBJbv26a8OLKvvAMfVajFEMEsXdfQWj5JACM3ClMRNg6dYNn1ELNgohy/XQxAa4SqoN/Rn9I334JWNgKKhGsZniGzYGje+9cbX3C+iQeTmWoSXy6hYlYYzossp7fDd6RVbC0aKOJzmoILTi4dIMhtPIpxN9aytD47lfTmps2Q9m0/4KpTJtr7aUf9yDw3DDIPx8o+JeGJIKwdrgCvtFVMDc7Ww2+NJNRYHAJ4lvfQ2jhMBBZ/Z2oXK1GEmE4bxoF7wPTchV10vrRTUsRXj4VsKqfbyyjRktRWM7thNIpa2AqK2wcQjrtLii40oE9CC4YCengd2xNyKjlUktBBOWz39Jut0iRUTdjMMQd7wMFy5lAADEM28XXwz3wCVjOOjcdbgpepmDgpvLcPjcCyc82MbWt+y+PJP2wXzUIvgdnazarFr/dhbpHbwUUuphQgLVbRUpdDeu65T44bx4Jc4U28cVaUF4wcAOLH0f8ncUQWIvwT1mZpHrcslkbYT23oxZ2T8kMLpuO2JvUBgXY4qXQWmnCurlwXNEbgoWRFY00rZ13cOl6bWzzKwgveRCwMTqWkpOwXtgDpZOWaLY3L9ccQu24HqAZevLa29LzcoIAS6tOcA9+Ara2F+X3/WmCebpi+QWX3oj4yVsIL50AJRJjZ7H9t1YiItz3PgbXTUM0m+lH31iN8LLxgD2PkzIxAnOzVnBcey+cPfrD5C0/HR/M/ntewaUXy9VO7gUSo70MQ2F7x7qHKDA3bgbvw0tgPUebYYISCSAw+16Ie3Zq9sM4jjgpBpKsg/PWiXD1uhOWs9qyd+Q9w59IfsAlBNKBvaiddFN98woxEUnXMPRWyK494Bu3VLNJWfKrTxB8fgyUYE26rcq8HF0VIRJgEmHrfAs89z0G8xktM5fDaA3twSUKxG+2I7jkEUg/7GQrZO+ETpHhfWgxHN2u08ZlqXRS8xH9y0KVd8rotU1yapUAthJYmreCtf0VcHS/FZZW7SBYGcpwqYJlNQdX+uHrVO9Cr6mHwN4mw3E2VCSYKlqi0Vx6T5k24YskEoR/zjCIuz4+mpknNy/SIzVIBiDYbLCc1x3Wdl1gbXsxrK06wdS4me5WC9K1hqbg0qinmuEXgBATBFZyfp3CMkq0Gt5x/wlXzz+ka7+My4l7PkPt5GsgWLyZD5kUMTVWJaIMwVUGc7MLYD2/C6ztLkqlsjeVN4VgNms2xMlYWQ0raAYuzcYSfWtt/TiO1YnYCQzr7j0EggbXPTW8KvnlR4h/8TEEW+bJ++jn3tLyPJibtoDJ6U6tCggOl4Z4sCtaM3DZVZm3zAgW4OAawYtFqAMHtwidbgSVObhG8GIR6sDBLUKnG0FlDq4RvFiEOnBwi9DpRlCZg2sELxahDhzcInS6EVTm4BrBi0WoAwe3CJ1uBJU5uEbwYhHqwMEtQqcbQWUOrhG8WIQ6cHCL0OlGUJmDawQvFqEOHNwidLoRVObgGsGLRagDB7cInW4ElTm4RvBiEerAwS1CpxtBZQ6uEbxYhDpwcIvQ6UZQmYNrBC8WoQ4c3CJ0uhFU5uAawYtFqAMHtwidbgSVObhG8GIR6sDBLUKnG0FlDq4RvFiEOnBwi9DpRlCZg2sELxahDhzcInS6EVTm4BrBi0WoAwe3CJ1uBJU5uEbwYhHqwMEtQqcbQWUOrhG8WIQ6cHCL0OlGUJmDawQvFqEOHNwidLoRVObgGsGLRagDB7cInW4Elf8fWDe3ft39HcYAAAAASUVORK5CYII=
openapi: 3.0.0
paths:
/download/logs/{logIds}:
get:
description: "This endpoint allows you to download and stream log events to\
\ your machine for the given log IDs and query parameters over HTTPS.\n<br>\n\
**Authentication**\n - Read / Write\n\n \n<br>\n\n## How to stream logs \n\
To stream more than one log event, use a colon to seperate each logID. \n\n\
<br> \n\n`https://REGION.rest.logs.insight.rapid7.com/download/logs/aee00b66-a543-43dc-b093-53963c2e8f41:d8eacea6-3dbd-4163-8fc2-3ef5067bd7c9:1c1f2885-ed93-4650-9e14-d46af4bf0886`\n\
\n<br>\n\n## Log Limit\nYou can download a maximum of 10 logs, or 20 million\
\ logs events, as indicated by the query parameter.\n\n<br>\n\n* Maximum number\
\ of download requests - 150\n* Maxium download size - 75 GB\n* Time window\
\ - 15 minutes"
operationId: Download_Logs
parameters:
- description: 'Lower bound of the time range you want to query against.Format:
UNIX timestamp in milliseconds. This is optional if `time_stamp` is supplied.'
in: query
name: from
required: false
schema:
type: string
- description: 'Upper bound of the time range you want to query against.Format:
UNIX timestamp in milliseconds.'
in: query
name: to
required: false
schema:
type: string
- description: 'The relative time range in a readable format.Optional if `from`
is supplied. Example: `Last 4 Days`'
in: query
name: time_range
required: false
schema:
type: string
- description: The LEQL query to match desired log events. Do not use a calculation.
in: query
name: query
required: false
schema:
type: string
- description: Max number of log events to download; cannot exceed 20 million.
The default is 20 million
in: query
name: limit
required: false
schema:
type: string
- description: Generated by shuffler.io OpenAPI
in: path
name: logIds
required: true
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Download Logs
/log_search/query/{query_id}:
get:
description: "Depending on the size of the underlying dataset of the complexity\
\ of the query, a request may not yield a value straight away. In this case\
\ a well-formed query will return an `HTTP 202` response and an ID you can\
\ use to check its state.\n<br>\nUse this with:\n* [Get Query](https://insightidr.help.rapid7.com/reference#getquerylogs)\n\
* [Get Saved Query](https://insightidr.help.rapid7.com/reference#getsavedquery)\n\
\n<br>\n\n**Authentication**\n - Read Only\n\n<br>\n\nUse the `ID` returned\
\ to poll the query. In this example the ID is `deace1fd-e605-41cd-a45c-5bf1ff0c3402-1`.\
\ \nThe link array object will return the query URL that can be used. \n\n\
<br>\n\n```bash\ncurl https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\
\ -H 'x-api-key: 00112233-4455-6677-8899-aabbccddeeff '\n```\n\n<br>\n\nThere\
\ is no limit on how frequently you can poll a query, or how many times you\
\ may poll it. However, if you do not poll a query resource for 20 seconds,\
\ it will expire. Subsequent calls to that resource will return a 404.\n\n\
<br>\n\n## How to poll a query\n\n1. Run the initial GET Query which will\
\ return a callback URL. \n\n<br>\n\n```json\n{\n \"logs\": [\n \"f9c6e2c1-ac7a-4a29-8faa-a8d70f96df70\"\
\n ],\n \"id\": \"deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\",\n \"progress\"\
:0,\n \"query\": {\n \"statement\": \"where(foo) calculate(count:x)\"\
,\n \"during\": {\n \"to\": 100000,\n \"from\": 100\n }\n\
\ },\n \"links\": [{\n \"rel\": \"self\",\n \"href\": \"https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\"\
\n }]\n}\n```\n\n<br>\n\n**Note**: If the initial GET Query is small, then\
\ the results are returned right away and there is no need to use the callback\
\ URL to poll.\n \n<br>\n\n2. Then use the callback URL to poll request and\
\ get log entries. \n\n<br>\n\n`\"href\": \"https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\"\
`\n\n<br>\n\n```json\n{\n \"logs\": [\n \"b7b33bce-58f1-42db-a36a-f452aa240d73\"\
\n ],\n \"events\": [\n {\n \"labels\": [],\n \"timestamp\"\
: 1583009183456,\n \"sequence_number\": 3234730521598636000,\n \"\
log_id\": \"b7b33bce-58f1-42db-a36a-f452aa240d73\",\n \"message\": \"\
{\\\"http.addr\\\" : \\\"176.9.8.97\\\",\\\"http.timestamp\\\" : \\\"2020-02-29\
\ 20:53:34.530862\\\",\\\"http.method\\\" : \\\"GET\\\",\\\"http.path\\\"\
\ : \\\"/resources/contact-us.php\\\",\\\"http.status\\\" : \\\"500\\\",\\\
\"http.bytes\\\" : 4046,\\\"http.referer\\\" : \\\"www.google.ie\\\",\\\"\
http.agent\\\" : \\\"Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) AppleWebKit/536.26\
\ (KHTML, like Gecko) Version/6.0 Mobile/10A5355d Safari/8536.25\\\",\\\"\
http.host\\\" : \\\"eu-prod-3\\\",\\\"http.responsetime\\\" : 11843}\",\n\
\ \"links\": [\n {\n \"rel\": \"Context\",\n \
\ \"href\": \"https://eu.api.insight.rapid7.com/log_search/query/context/3234730521598636032?per_page=50×tamp=1583009183456&log_keys=b7b33bce-58f1-42db-a36a-f452aa240d73&context_type=SURROUND\"\
\n }\n ]\n }\n ],\n \"leql\": {\n \"statement\": \"where(http.status)\"\
,\n \"during\": {\n \"from\": 1583009182433,\n \"to\": 1585601175000,\n\
\ \"time_range\": \"Last 30 Days\"\n }\n }\n}\n```"
operationId: Get_A_Long_Running_Query
parameters:
- description: Generated by shuffler.io OpenAPI
in: path
name: query_id
required: true
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Get A Long Running Query
/management/logs:
get:
description: "Request used to list all Logs for an account.\n\n<br>\n\n**Authentication**\n\
\ - Read Write\n - Read Only"
operationId: Get_All_Logs
parameters: []
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Get All Logs
/management/logs/{logId}:
get:
description: "Request used to get a specific Log from an account.\n\n<br>\n\n\
**Authentication**\n - Read Write\n - Read Only\n\n\n\n\n\n\n\n\n"
operationId: Get_a_Log
parameters:
- description: Generated by shuffler.io OpenAPI
in: path
name: logId
required: true
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Get a Log
/management/logsets:
get:
description: "Get all Log Sets from an account.\n\n<br>\n\n**Authentication**\n\
\ - Owner\n - Read Write\n - Read Only"
operationId: Get_All_Log_Sets
parameters: []
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Get All Log Sets
/management/logsets/{logsetid}:
get:
description: "Get a specific LogSet from an account. \n\n<br>\n\n**Authentication**\n\
\ - Owner\n - Read Write\n - Read Only"
operationId: Get_A_Log_Set
parameters:
- description: Generated by shuffler.io OpenAPI
in: path
name: logsetid
required: true
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Get A Log Set
/query/logs/{log_id}:
get:
description: "Query your Log entries using a LEQL query.\n\n<br>\n\n**Authentication**\n\
\ - Read Only\n\n \n<br>\n\nDepending on the size of the underlying dataset\
\ of the complexity of the query, a request may not yield a value straight\
\ away. In this case a well-formed query will return an `HTTP 202` response\
\ and an ID you can use to check its state.\n\n<br>\n\nUse the `ID` returned\
\ to poll the query. In this example the ID is `deace1fd-e605-41cd-a45c-5bf1ff0c3402-1`.\
\ \nThe link array object will return the query URL that can be used. \n\n\
<br>\n\n```bash\ncurl https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\
\ -H 'x-api-key: 00112233-4455-6677-8899-aabbccddeeff '\n```\n\n<br>\n\nThere\
\ is no limit on how frequently you can poll a query, or how many times you\
\ may poll it. However, if you do not poll a query resource for 20 seconds,\
\ it will expire. Subsequent calls to that resource will return a 404.\n\n\
<br>\n\n## How to poll a query\n1. Run the initial GET Query which will return\
\ a callback URL. \n\n<br>\n\n```json\n{\n \"logs\": [\n \"f9c6e2c1-ac7a-4a29-8faa-a8d70f96df70\"\
\n ],\n \"id\": \"deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\",\n \"progress\"\
:0,\n \"query\": {\n \"statement\": \"where(foo) calculate(count:x)\"\
,\n \"during\": {\n \"to\": 100000,\n \"from\": 100\n }\n\
\ },\n \"links\": [{\n \"rel\": \"self\",\n \"href\": \"https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\"\
\n }]\n}\n```\n\n<br>\n\n**Note**: If the initial GET Query is small, then\
\ the results are returned right away and there is no need to use the callback\
\ URL to poll. \n\n<br>\n\n2. Then use the callback URL to poll request and\
\ get log entries. \n\n<br>\n\n`\"href\": \"https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\"\
`\n\n<br>\n\n```json\n{\n \"logs\": [\n \"b7b33bce-58f1-42db-a36a-f452aa240d73\"\
\n ],\n \"events\": [\n {\n \"labels\": [],\n \"timestamp\"\
: 1583009183456,\n \"sequence_number\": 3234730521598636000,\n \"\
log_id\": \"b7b33bce-58f1-42db-a36a-f452aa240d73\",\n \"message\": \"\
{\\\"http.addr\\\" : \\\"176.9.8.97\\\",\\\"http.timestamp\\\" : \\\"2020-02-29\
\ 20:53:34.530862\\\",\\\"http.method\\\" : \\\"GET\\\",\\\"http.path\\\"\
\ : \\\"/resources/contact-us.php\\\",\\\"http.status\\\" : \\\"500\\\",\\\
\"http.bytes\\\" : 4046,\\\"http.referer\\\" : \\\"www.google.ie\\\",\\\"\
http.agent\\\" : \\\"Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) AppleWebKit/536.26\
\ (KHTML, like Gecko) Version/6.0 Mobile/10A5355d Safari/8536.25\\\",\\\"\
http.host\\\" : \\\"eu-prod-3\\\",\\\"http.responsetime\\\" : 11843}\",\n\
\ \"links\": [\n {\n \"rel\": \"Context\",\n \
\ \"href\": \"https://eu.api.insight.rapid7.com/log_search/query/context/3234730521598636032?per_page=50×tamp=1583009183456&log_keys=b7b33bce-58f1-42db-a36a-f452aa240d73&context_type=SURROUND\"\
\n }\n ]\n }\n ],\n \"leql\": {\n \"statement\": \"where(http.status)\"\
,\n \"during\": {\n \"from\": 1583009182433,\n \"to\": 1585601175000,\n\
\ \"time_range\": \"Last 30 Days\"\n }\n }\n}\n```"
operationId: Get_A_Query
parameters:
- description: "A valid [LEQL query](https://docs.logentries.com/docs/search#section-leql)\
\ to run against the log. \nFormat: url-encoded string.\nExample: `query=where(foo=bar)`"
in: query
name: query
required: true
schema:
type: string
- description: "Lower bound of the time range you want to query against. \n\
Format: UNIX timestamp in milliseconds. \nExample:`1450557004000`"
in: query
name: from
required: true
schema:
type: string
- description: "Upper bound of the time range you want to query against. \n\
Format:UNIX timestamp in milliseconds. \nExample:`1460557604000`"
in: query
name: to
required: true
schema:
type: string
- description: 'Number of log entries to return per page. Default of 50.
Example: `per_page=50`'
in: query
name: per_page
required: false
schema:
type: string
- description: "The earlier sequence number of a log entry to start searching\
\ from. \nExample: `sequence_number=10`"
in: query
name: sequence_number
required: false
schema:
type: string
- description: Generated by shuffler.io OpenAPI
in: path
name: log_id
required: true
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Get A Query
/query/saved_queries:
get:
description: "Returns all saved queries. To return a specific save query use\
\ the `query_id` parameter.\n\n<br>\n\n**Authentication**\n* Owner\n* Read\
\ Write\n* Read Only\n\n<br>\n\nDepending on the size of the underlying dataset\
\ of the complexity of the query, a request may not yield a value straight\
\ away. In this case a well-formed query will return an `HTTP 202` response\
\ and an ID you can use to check its state.\n\n<br>\n\nUse the `ID` returned\
\ to poll the query. In this example the ID is `deace1fd-e605-41cd-a45c-5bf1ff0c3402-1`.\
\ \nThe link array object will return the query URL that can be used. \n\n\
<br>\n\n```bash\ncurl https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\
\ -H 'x-api-key: 00112233-4455-6677-8899-aabbccddeeff '\n```\n<br>\n\nThere\
\ is no limit on how frequently you can poll a query, or how many times you\
\ may poll it. However, if you do not poll a query resource for 20 seconds,\
\ it will expire. Subsequent calls to that resource will return a 404.\n\n\
<br>\n\n## How to poll a query\n\n<br>\n\n1. Run the initial GET Query which\
\ will return a callback URL.\n \n<br>\n\n```json\n{\n \"logs\": [\n \"\
f9c6e2c1-ac7a-4a29-8faa-a8d70f96df70\"\n ],\n \"id\": \"deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\"\
,\n \"progress\":0,\n \"query\": {\n \"statement\": \"where(foo) calculate(count:x)\"\
,\n \"during\": {\n \"to\": 100000,\n \"from\": 100\n }\n\
\ },\n \"links\": [{\n \"rel\": \"self\",\n \"href\": \"https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\"\
\n }]\n}\n```\n\n<br>\n\n**Note**: If the initial GET Query is small, then\
\ the results are returned right away and there is no need to use the callback\
\ URL to poll.\n \n<br>\n\n2. Then use the callback URL to poll request and\
\ get log entries. \n\n<br>\n\n`\"href\": \"https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\"\
`\n\n<br>\n\n```json\n{\n \"logs\": [\n \"b7b33bce-58f1-42db-a36a-f452aa240d73\"\
\n ],\n \"events\": [\n {\n \"labels\": [],\n \"timestamp\"\
: 1583009183456,\n \"sequence_number\": 3234730521598636000,\n \"\
log_id\": \"b7b33bce-58f1-42db-a36a-f452aa240d73\",\n \"message\": \"\
{\\\"http.addr\\\" : \\\"176.9.8.97\\\",\\\"http.timestamp\\\" : \\\"2020-02-29\
\ 20:53:34.530862\\\",\\\"http.method\\\" : \\\"GET\\\",\\\"http.path\\\"\
\ : \\\"/resources/contact-us.php\\\",\\\"http.status\\\" : \\\"500\\\",\\\
\"http.bytes\\\" : 4046,\\\"http.referer\\\" : \\\"www.google.ie\\\",\\\"\
http.agent\\\" : \\\"Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) AppleWebKit/536.26\
\ (KHTML, like Gecko) Version/6.0 Mobile/10A5355d Safari/8536.25\\\",\\\"\
http.host\\\" : \\\"eu-prod-3\\\",\\\"http.responsetime\\\" : 11843}\",\n\
\ \"links\": [\n {\n \"rel\": \"Context\",\n \
\ \"href\": \"https://eu.api.insight.rapid7.com/log_search/query/context/3234730521598636032?per_page=50×tamp=1583009183456&log_keys=b7b33bce-58f1-42db-a36a-f452aa240d73&context_type=SURROUND\"\
\n }\n ]\n }\n ],\n \"leql\": {\n \"statement\": \"where(http.status)\"\
,\n \"during\": {\n \"from\": 1583009182433,\n \"to\": 1585601175000,\n\
\ \"time_range\": \"Last 30 Days\"\n }\n }\n}\n```"
operationId: Get_All_Saved_Queries
parameters:
- description: 'The UUID to return a specific query.
Example: `de305d54-75b4-431b-adb2-eb6b9e546014`'
in: query
name: queryid
required: false
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Get All Saved Queries
post:
description: 'Request to create a new Saved Query.
<br>
**Authentication**
* Owner
* Read Write'
operationId: Create_a_Saved_Query
parameters:
- description: Header generated by shuffler.io OpenAPI
example: application/json
in: header
multiline: false
name: Content-Type
required: false
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Create a Saved Query
/query/saved_queries/{saved_query_id}:
delete:
description: Delete a Saved Query.
operationId: Delete_A_Saved_Query
parameters:
- description: Generated by shuffler.io OpenAPI
in: path
name: saved_query_id
required: true
schema:
type: string
- description: Header generated by shuffler.io OpenAPI
example: application/json
in: header
multiline: false
name: Content-Type
required: false
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Delete A Saved Query
patch:
description: Request used to update a given resource for a specified saved query.
operationId: Modify_a_Saved_Query
parameters:
- description: Generated by shuffler.io OpenAPI
in: path
name: saved_query_id
required: true
schema:
type: string
- description: Header generated by shuffler.io OpenAPI
example: application/json
in: header
multiline: false
name: Content-Type
required: false
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Modify a Saved Query
put:
description: 'Replace the attributes of a saved query.
<br>
Full object must be used when performing this request otherwise it will fail.'
operationId: Update_a_Saved_Query
parameters:
- description: Generated by shuffler.io OpenAPI
in: path
name: saved_query_id
required: true
schema:
type: string
- description: Header generated by shuffler.io OpenAPI
example: application/json
in: header
multiline: false
name: Content-Type
required: false
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Update a Saved Query
/query/saved_query/{saved_query_id}:
get:
description: "Request used to Query your Log entries using a Saved Query.\n\n\
<br>\n\nNote that if you are already using a from and to value in your Saved\
\ Query then they are not required for performing a GET request.\n\n<br>\n\
\n**Authentication**\n - Read Only\n\n \n<br>\n\nDepending on the size of\
\ the underlying dataset of the complexity of the query, a request may not\
\ yield a value straight away. In this case a well-formed query will return\
\ an `HTTP 202` response and an ID you can use to check its state.\n\n<br>\n\
\nUse the `ID` returned to poll the query. In this example the ID is `deace1fd-e605-41cd-a45c-5bf1ff0c3402-1`.\
\ \nThe link array object will return the query URL that can be used. \n\n\
<br>\n\n```bash\ncurl https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\
\ -H 'x-api-key: 00112233-4455-6677-8899-aabbccddeeff '\n```\n\n<br>\n\nThere\
\ is no limit on how frequently you can poll a query, or how many times you\
\ may poll it. However, if you do not poll a query resource for 20 seconds,\
\ it will expire. Subsequent calls to that resource will return a 404.\n\n\
<br>\n\n## How to poll a query\n\n1. Run the initial GET Query which will\
\ return a callback URL. \n\n<br>\n\n```json\n{\n \"logs\": [\n \"f9c6e2c1-ac7a-4a29-8faa-a8d70f96df70\"\
\n ],\n \"id\": \"deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\",\n \"progress\"\
:0,\n \"query\": {\n \"statement\": \"where(foo) calculate(count:x)\"\
,\n \"during\": {\n \"to\": 100000,\n \"from\": 100\n }\n\
\ },\n \"links\": [{\n \"rel\": \"self\",\n \"href\": \"https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\"\
\n }]\n}\n```\n\n<br>\n\n**Note**: If the initial GET Query is small, then\
\ the results are returned right away and there is no need to use the callback\
\ URL to poll.\n \n<br>\n\n2. Then use the callback URL to poll request and\
\ get log entries. \n\n<br>\n\n`\"href\": \"https://us.rest.logs.insight.rapid7.com/query/deace1fd-e605-41cd-a45c-5bf1ff0c3402-1\"\
`\n\n<br>\n\n```json\n{\n \"logs\": [\n \"b7b33bce-58f1-42db-a36a-f452aa240d73\"\
\n ],\n \"events\": [\n {\n \"labels\": [],\n \"timestamp\"\
: 1583009183456,\n \"sequence_number\": 3234730521598636000,\n \"\
log_id\": \"b7b33bce-58f1-42db-a36a-f452aa240d73\",\n \"message\": \"\
{\\\"http.addr\\\" : \\\"176.9.8.97\\\",\\\"http.timestamp\\\" : \\\"2020-02-29\
\ 20:53:34.530862\\\",\\\"http.method\\\" : \\\"GET\\\",\\\"http.path\\\"\
\ : \\\"/resources/contact-us.php\\\",\\\"http.status\\\" : \\\"500\\\",\\\
\"http.bytes\\\" : 4046,\\\"http.referer\\\" : \\\"www.google.ie\\\",\\\"\
http.agent\\\" : \\\"Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) AppleWebKit/536.26\
\ (KHTML, like Gecko) Version/6.0 Mobile/10A5355d Safari/8536.25\\\",\\\"\
http.host\\\" : \\\"eu-prod-3\\\",\\\"http.responsetime\\\" : 11843}\",\n\
\ \"links\": [\n {\n \"rel\": \"Context\",\n \
\ \"href\": \"https://eu.api.insight.rapid7.com/log_search/query/context/3234730521598636032?per_page=50×tamp=1583009183456&log_keys=b7b33bce-58f1-42db-a36a-f452aa240d73&context_type=SURROUND\"\
\n }\n ]\n }\n ],\n \"leql\": {\n \"statement\": \"where(http.status)\"\
,\n \"during\": {\n \"from\": 1583009182433,\n \"to\": 1585601175000,\n\
\ \"time_range\": \"Last 30 Days\"\n }\n }\n}\n```"
operationId: Get_A_Saved_Query
parameters:
- description: 'Lower bound of the time range you want to query against.
Format: UNIX timestamp in milliseconds
Example: `from=1450557604000`'
in: query
name: from
required: false
schema:
type: string
- description: 'Lower bound of the time range you want to query against.
Format: UNIX timestamp in milliseconds
Example: `to=1460557604000`'
in: query
name: to
required: false
schema:
type: string
- description: "Number of log entries to return per page. Default of 50.\nExample:\
\ `per_page=50`\t"
in: query
name: per_page
required: false
schema:
type: string
- description: "The earlier sequence number of a log entry to start searching\
\ from.\nExample:`sequence_number=10`\t"
in: query
name: sequence_number
required: false
schema:
type: string
- description: Generated by shuffler.io OpenAPI
in: path
name: saved_query_id
required: true
schema:
type: string
requestBody:
content: {}
responses:
default:
content:
text/plain:
schema:
example: ''
type: string
description: default
summary: Get A Saved Query
schemes:
- 'https:'
servers:
- url: https://eu.api.insight.rapid7.com/log_search
tags:
- name: Query
- name: Logs
- name: Logsets
- name: Saved Queries
- name: IDR