@itentialopensource/adapter-splunk 0.1.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/.eslintignore +0 -1
  2. package/.jshintrc +3 -0
  3. package/AUTH.md +5 -11
  4. package/CALLS.md +317 -23
  5. package/CHANGELOG.md +16 -1
  6. package/CONTRIBUTING.md +1 -160
  7. package/ENHANCE.md +2 -2
  8. package/README.md +31 -22
  9. package/SYSTEMINFO.md +11 -3
  10. package/adapter.js +159 -330
  11. package/adapterBase.js +538 -873
  12. package/changelogs/changelog.md +9 -0
  13. package/metadata.json +59 -0
  14. package/package.json +23 -25
  15. package/pronghorn.json +474 -142
  16. package/propertiesSchema.json +444 -40
  17. package/refs?service=git-upload-pack +0 -0
  18. package/report/adapter-openapi.json +2340 -0
  19. package/report/adapter-openapi.yaml +1690 -0
  20. package/report/adapterInfo.json +10 -0
  21. package/report/updateReport1691508892522.json +120 -0
  22. package/report/updateReport1692202206847.json +120 -0
  23. package/report/updateReport1692203308193.json +120 -0
  24. package/report/updateReport1694469246825.json +120 -0
  25. package/sampleProperties.json +65 -4
  26. package/test/integration/adapterTestBasicGet.js +1 -1
  27. package/test/integration/adapterTestConnectivity.js +91 -42
  28. package/test/integration/adapterTestIntegration.js +130 -2
  29. package/test/unit/adapterBaseTestUnit.js +388 -313
  30. package/test/unit/adapterTestUnit.js +306 -109
  31. package/utils/adapterInfo.js +1 -1
  32. package/utils/addAuth.js +1 -1
  33. package/utils/artifactize.js +1 -1
  34. package/utils/checkMigrate.js +1 -1
  35. package/utils/entitiesToDB.js +1 -0
  36. package/utils/findPath.js +1 -1
  37. package/utils/methodDocumentor.js +57 -22
  38. package/utils/modify.js +13 -15
  39. package/utils/packModificationScript.js +1 -1
  40. package/utils/taskMover.js +309 -0
  41. package/utils/tbScript.js +3 -10
  42. package/utils/tbUtils.js +2 -3
  43. package/utils/testRunner.js +1 -1
  44. package/utils/troubleshootingAdapter.js +1 -3
  45. package/workflows/README.md +0 -3
@@ -0,0 +1,1690 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: Splunk Adapter
4
+ description: Splunk Adapter API calls
5
+ contact:
6
+ email: venu.madhav@itential.com
7
+ version: '1.0.0'
8
+ servers:
9
+ - url: https://www.example.com/
10
+ variables: {}
11
+ paths:
12
+ /services/data/commands/{name}:
13
+ get:
14
+ tags:
15
+ - default
16
+ summary: getDataCommandsByName
17
+ description: getDataCommandsByName
18
+ operationId: getDataCommandsByName
19
+ parameters:
20
+ - name: name
21
+ in: path
22
+ description: name
23
+ required: true
24
+ style: simple
25
+ schema:
26
+ type: string
27
+ responses:
28
+ '200':
29
+ description: successful operation
30
+ headers: {}
31
+ content: {}
32
+ '400':
33
+ description: failed operation
34
+ headers: {}
35
+ content: {}
36
+ deprecated: false
37
+ /services/saved/searches:
38
+ get:
39
+ tags:
40
+ - default
41
+ summary: getSavedSearches
42
+ description: getSavedSearches
43
+ operationId: getSavedSearches
44
+ parameters:
45
+ - name: earliest_time10-20-2022
46
+ in: query
47
+ description: earliest_time10-20-2022
48
+ required: true
49
+ style: form
50
+ explode: true
51
+ schema:
52
+ type: string
53
+ - name: latest_time
54
+ in: query
55
+ description: latest_time
56
+ required: true
57
+ style: form
58
+ explode: true
59
+ schema:
60
+ type: string
61
+ - name: listDefaultActionArgs
62
+ in: query
63
+ description: listDefaultActionArgs
64
+ required: true
65
+ style: form
66
+ explode: true
67
+ schema:
68
+ type: string
69
+ - name: add_orphan_field
70
+ in: query
71
+ description: add_orphan_field
72
+ required: true
73
+ style: form
74
+ explode: true
75
+ schema:
76
+ type: string
77
+ responses:
78
+ '200':
79
+ description: successful operation
80
+ headers: {}
81
+ content: {}
82
+ '400':
83
+ description: failed operation
84
+ headers: {}
85
+ content: {}
86
+ deprecated: false
87
+ /services/admin/search/saved/searches/{name}:
88
+ delete:
89
+ tags:
90
+ - default
91
+ summary: deleteSavedSearchesByName
92
+ description: deleteSavedSearchesByName
93
+ operationId: deleteSavedSearchesByName
94
+ parameters:
95
+ - name: name
96
+ in: path
97
+ description: name
98
+ required: true
99
+ style: simple
100
+ schema:
101
+ type: string
102
+ responses:
103
+ '200':
104
+ description: successful operation
105
+ headers: {}
106
+ content: {}
107
+ '400':
108
+ description: failed operation
109
+ headers: {}
110
+ content: {}
111
+ deprecated: false
112
+ get:
113
+ tags:
114
+ - default
115
+ summary: getSavedSearchesByName
116
+ description: getSavedSearchesByName
117
+ operationId: getSavedSearchesByName
118
+ parameters:
119
+ - name: name
120
+ in: path
121
+ description: name
122
+ required: true
123
+ style: simple
124
+ schema:
125
+ type: string
126
+ - name: earliest_time10-20-2022
127
+ in: query
128
+ description: earliest_time10-20-2022
129
+ required: true
130
+ style: form
131
+ explode: true
132
+ schema:
133
+ type: string
134
+ - name: latest_time
135
+ in: query
136
+ description: latest_time
137
+ required: true
138
+ style: form
139
+ explode: true
140
+ schema:
141
+ type: string
142
+ - name: listDefaultActionArgs
143
+ in: query
144
+ description: listDefaultActionArgs
145
+ required: true
146
+ style: form
147
+ explode: true
148
+ schema:
149
+ type: string
150
+ - name: add_orphan_field
151
+ in: query
152
+ description: add_orphan_field
153
+ required: true
154
+ style: form
155
+ explode: true
156
+ schema:
157
+ type: string
158
+ responses:
159
+ '200':
160
+ description: successful operation
161
+ headers: {}
162
+ content: {}
163
+ '400':
164
+ description: failed operation
165
+ headers: {}
166
+ content: {}
167
+ deprecated: false
168
+ post:
169
+ tags:
170
+ - default
171
+ summary: postSavedSearches
172
+ description: postSavedSearches
173
+ operationId: postSavedSearches
174
+ parameters:
175
+ - name: name
176
+ in: path
177
+ description: name
178
+ required: true
179
+ style: simple
180
+ schema:
181
+ type: string
182
+ requestBody:
183
+ description: body
184
+ content:
185
+ '*/*':
186
+ schema:
187
+ description: body
188
+ example:
189
+ actions: email
190
+ action.email.to: nobody@example.com, info@example.com
191
+ search: my search here
192
+ example:
193
+ actions: email
194
+ action.email.to: nobody@example.com, info@example.com
195
+ search: my search here
196
+ required: true
197
+ responses:
198
+ '200':
199
+ description: successful operation
200
+ headers: {}
201
+ content: {}
202
+ '400':
203
+ description: failed operation
204
+ headers: {}
205
+ content: {}
206
+ deprecated: false
207
+ /services/admin/search/saved/searches/{name}/acknowledge:
208
+ post:
209
+ tags:
210
+ - default
211
+ summary: postSavedSearchesAcknowledge
212
+ description: postSavedSearchesAcknowledge
213
+ operationId: postSavedSearchesAcknowledge
214
+ parameters:
215
+ - name: name
216
+ in: path
217
+ description: name
218
+ required: true
219
+ style: simple
220
+ schema:
221
+ type: string
222
+ requestBody:
223
+ description: body
224
+ content:
225
+ '*/*':
226
+ schema:
227
+ description: body
228
+ example:
229
+ key: string
230
+ example:
231
+ key: string
232
+ required: true
233
+ responses:
234
+ '200':
235
+ description: successful operation
236
+ headers: {}
237
+ content: {}
238
+ '400':
239
+ description: failed operation
240
+ headers: {}
241
+ content: {}
242
+ deprecated: false
243
+ /services/saved/searches/{name}/dispatch:
244
+ post:
245
+ tags:
246
+ - default
247
+ summary: postSavedSearchesDispatchByName
248
+ description: postSavedSearchesDispatchByName
249
+ operationId: postSavedSearchesDispatchByName
250
+ parameters:
251
+ - name: name
252
+ in: path
253
+ description: name
254
+ required: true
255
+ style: simple
256
+ schema:
257
+ type: string
258
+ requestBody:
259
+ description: body
260
+ content:
261
+ '*/*':
262
+ schema:
263
+ description: body
264
+ example:
265
+ trigger_actions: true
266
+ dispatchAs: owner
267
+ dispatch.adhoc_search_level: verbose
268
+ dispatch.now: true
269
+ force_dispatch: true
270
+ replay_speed: 1
271
+ replay_et: earliest
272
+ replay_lt: latest
273
+ example:
274
+ trigger_actions: true
275
+ dispatchAs: owner
276
+ dispatch.adhoc_search_level: verbose
277
+ dispatch.now: true
278
+ force_dispatch: true
279
+ replay_speed: 1
280
+ replay_et: earliest
281
+ replay_lt: latest
282
+ required: true
283
+ responses:
284
+ '200':
285
+ description: successful operation
286
+ headers: {}
287
+ content: {}
288
+ '400':
289
+ description: failed operation
290
+ headers: {}
291
+ content: {}
292
+ deprecated: false
293
+ /services/saved/searches/{name}/history:
294
+ get:
295
+ tags:
296
+ - default
297
+ summary: getSavedSearchesHistoryByName
298
+ description: getSavedSearchesHistoryByName
299
+ operationId: getSavedSearchesHistoryByName
300
+ parameters:
301
+ - name: name
302
+ in: path
303
+ description: name
304
+ required: true
305
+ style: simple
306
+ schema:
307
+ type: string
308
+ - name: savedsearch
309
+ in: query
310
+ description: savedsearch
311
+ required: true
312
+ style: form
313
+ explode: true
314
+ schema:
315
+ type: string
316
+ responses:
317
+ '200':
318
+ description: successful operation
319
+ headers: {}
320
+ content: {}
321
+ '400':
322
+ description: failed operation
323
+ headers: {}
324
+ content: {}
325
+ deprecated: false
326
+ /services/saved/searches/{name}/reschedule:
327
+ post:
328
+ tags:
329
+ - default
330
+ summary: postSavedSearchesReschedule
331
+ description: postSavedSearchesReschedule
332
+ operationId: postSavedSearchesReschedule
333
+ parameters:
334
+ - name: name
335
+ in: path
336
+ description: name
337
+ required: true
338
+ style: simple
339
+ schema:
340
+ type: string
341
+ requestBody:
342
+ description: body
343
+ content:
344
+ '*/*':
345
+ schema:
346
+ description: body
347
+ example:
348
+ schedule_time: 2012-08-15T14:11:01Z
349
+ example:
350
+ schedule_time: 2012-08-15T14:11:01Z
351
+ required: true
352
+ responses:
353
+ '200':
354
+ description: successful operation
355
+ headers: {}
356
+ content: {}
357
+ '400':
358
+ description: failed operation
359
+ headers: {}
360
+ content: {}
361
+ deprecated: false
362
+ /services/saved/searches/{name}/scheduled_times:
363
+ get:
364
+ tags:
365
+ - default
366
+ summary: getSavedSearchesScheduledItemsByName
367
+ description: getSavedSearchesScheduledItemsByName
368
+ operationId: getSavedSearchesScheduledItemsByName
369
+ parameters:
370
+ - name: name
371
+ in: path
372
+ description: name
373
+ required: true
374
+ style: simple
375
+ schema:
376
+ type: string
377
+ - name: earliest_time
378
+ in: query
379
+ description: earliest_time
380
+ required: true
381
+ style: form
382
+ explode: true
383
+ schema:
384
+ type: string
385
+ - name: latest_time
386
+ in: query
387
+ description: latest_time
388
+ required: true
389
+ style: form
390
+ explode: true
391
+ schema:
392
+ type: string
393
+ responses:
394
+ '200':
395
+ description: successful operation
396
+ headers: {}
397
+ content: {}
398
+ '400':
399
+ description: failed operation
400
+ headers: {}
401
+ content: {}
402
+ deprecated: false
403
+ /services/saved/searches/{name}/suppress:
404
+ get:
405
+ tags:
406
+ - default
407
+ summary: getSavedSearchesSupresssByName
408
+ description: getSavedSearchesSupresssByName
409
+ operationId: getSavedSearchesSupresssByName
410
+ parameters:
411
+ - name: name
412
+ in: path
413
+ description: name
414
+ required: true
415
+ style: simple
416
+ schema:
417
+ type: string
418
+ - name: expiration
419
+ in: query
420
+ description: expiration
421
+ required: true
422
+ style: form
423
+ explode: true
424
+ schema:
425
+ type: string
426
+ responses:
427
+ '200':
428
+ description: successful operation
429
+ headers: {}
430
+ content: {}
431
+ '400':
432
+ description: failed operation
433
+ headers: {}
434
+ content: {}
435
+ deprecated: false
436
+ /services/scheduled/views:
437
+ get:
438
+ tags:
439
+ - default
440
+ summary: getScheduledViews
441
+ description: getScheduledViews
442
+ operationId: getScheduledViews
443
+ parameters:
444
+ - name: count
445
+ in: query
446
+ description: count
447
+ required: true
448
+ style: form
449
+ explode: true
450
+ schema:
451
+ type: string
452
+ - name: f
453
+ in: query
454
+ description: f
455
+ required: true
456
+ style: form
457
+ explode: true
458
+ schema:
459
+ type: string
460
+ - name: offset
461
+ in: query
462
+ description: offset
463
+ required: true
464
+ style: form
465
+ explode: true
466
+ schema:
467
+ type: string
468
+ - name: search
469
+ in: query
470
+ description: search
471
+ required: true
472
+ style: form
473
+ explode: true
474
+ schema:
475
+ type: string
476
+ - name: sort_dir
477
+ in: query
478
+ description: sort_dir
479
+ required: true
480
+ style: form
481
+ explode: true
482
+ schema:
483
+ type: string
484
+ - name: sort_key
485
+ in: query
486
+ description: sort_key
487
+ required: true
488
+ style: form
489
+ explode: true
490
+ schema:
491
+ type: string
492
+ - name: sort_mode
493
+ in: query
494
+ description: sort_mode
495
+ required: true
496
+ style: form
497
+ explode: true
498
+ schema:
499
+ type: string
500
+ - name: summarize
501
+ in: query
502
+ description: summarize
503
+ required: true
504
+ style: form
505
+ explode: true
506
+ schema:
507
+ type: string
508
+ responses:
509
+ '200':
510
+ description: successful operation
511
+ headers: {}
512
+ content: {}
513
+ '400':
514
+ description: failed operation
515
+ headers: {}
516
+ content: {}
517
+ deprecated: false
518
+ /services/scheduled/views/{name}:
519
+ delete:
520
+ tags:
521
+ - default
522
+ summary: deleteScheduledViewByName
523
+ description: deleteScheduledViewByName
524
+ operationId: deleteScheduledViewByName
525
+ parameters:
526
+ - name: name
527
+ in: path
528
+ description: name
529
+ required: true
530
+ style: simple
531
+ schema:
532
+ type: string
533
+ responses:
534
+ '200':
535
+ description: successful operation
536
+ headers: {}
537
+ content: {}
538
+ '400':
539
+ description: failed operation
540
+ headers: {}
541
+ content: {}
542
+ deprecated: false
543
+ get:
544
+ tags:
545
+ - default
546
+ summary: getScheduledViewByName
547
+ description: getScheduledViewByName
548
+ operationId: getScheduledViewByName
549
+ parameters:
550
+ - name: name
551
+ in: path
552
+ description: name
553
+ required: true
554
+ style: simple
555
+ schema:
556
+ type: string
557
+ responses:
558
+ '200':
559
+ description: successful operation
560
+ headers: {}
561
+ content: {}
562
+ '400':
563
+ description: failed operation
564
+ headers: {}
565
+ content: {}
566
+ deprecated: false
567
+ post:
568
+ tags:
569
+ - default
570
+ summary: postScheduledViewByName
571
+ description: postScheduledViewByName
572
+ operationId: postScheduledViewByName
573
+ parameters:
574
+ - name: name
575
+ in: path
576
+ description: name
577
+ required: true
578
+ style: simple
579
+ schema:
580
+ type: string
581
+ requestBody:
582
+ description: body
583
+ content:
584
+ '*/*':
585
+ schema:
586
+ description: body
587
+ example:
588
+ action.email.to: user1@test.com,user2@test.com
589
+ action.email*: ''
590
+ cron_schedule: '*/5 * * * * '
591
+ description: description
592
+ disabled: false
593
+ is_scheduled: true
594
+ next_scheduled_time: ''
595
+ example:
596
+ action.email.to: user1@test.com,user2@test.com
597
+ action.email*: ''
598
+ cron_schedule: '*/5 * * * * '
599
+ description: description
600
+ disabled: false
601
+ is_scheduled: true
602
+ next_scheduled_time: ''
603
+ required: true
604
+ responses:
605
+ '200':
606
+ description: successful operation
607
+ headers: {}
608
+ content: {}
609
+ '400':
610
+ description: failed operation
611
+ headers: {}
612
+ content: {}
613
+ deprecated: false
614
+ /services/scheduled/views/{name}/dispatch:
615
+ post:
616
+ tags:
617
+ - default
618
+ summary: postScheduledViewDispatch
619
+ description: postScheduledViewDispatch
620
+ operationId: postScheduledViewDispatch
621
+ parameters:
622
+ - name: name
623
+ in: path
624
+ description: name
625
+ required: true
626
+ style: simple
627
+ schema:
628
+ type: string
629
+ requestBody:
630
+ description: body
631
+ content:
632
+ '*/*':
633
+ schema:
634
+ description: body
635
+ example:
636
+ dispatch.now: true
637
+ force_dispatch: true
638
+ trigger_actions: true
639
+ args.*: $username$
640
+ example:
641
+ dispatch.now: true
642
+ force_dispatch: true
643
+ trigger_actions: true
644
+ args.*: $username$
645
+ required: true
646
+ responses:
647
+ '200':
648
+ description: successful operation
649
+ headers: {}
650
+ content: {}
651
+ '400':
652
+ description: failed operation
653
+ headers: {}
654
+ content: {}
655
+ deprecated: false
656
+ /services/scheduled/views/{name}/history:
657
+ get:
658
+ tags:
659
+ - default
660
+ summary: getScheduledViewHistory
661
+ description: getScheduledViewHistory
662
+ operationId: getScheduledViewHistory
663
+ parameters:
664
+ - name: name
665
+ in: path
666
+ description: name
667
+ required: true
668
+ style: simple
669
+ schema:
670
+ type: string
671
+ responses:
672
+ '200':
673
+ description: successful operation
674
+ headers: {}
675
+ content: {}
676
+ '400':
677
+ description: failed operation
678
+ headers: {}
679
+ content: {}
680
+ deprecated: false
681
+ /services/scheduled/views/{name}/reschedule:
682
+ post:
683
+ tags:
684
+ - default
685
+ summary: postScheduledViewHistory
686
+ description: postScheduledViewHistory
687
+ operationId: postScheduledViewHistory
688
+ parameters:
689
+ - name: name
690
+ in: path
691
+ description: name
692
+ required: true
693
+ style: simple
694
+ schema:
695
+ type: string
696
+ requestBody:
697
+ description: body
698
+ content:
699
+ '*/*':
700
+ schema:
701
+ description: body
702
+ example:
703
+ schedule_time: 2013-02-15T14:11:01Z
704
+ example:
705
+ schedule_time: 2013-02-15T14:11:01Z
706
+ required: true
707
+ responses:
708
+ '200':
709
+ description: successful operation
710
+ headers: {}
711
+ content: {}
712
+ '400':
713
+ description: failed operation
714
+ headers: {}
715
+ content: {}
716
+ deprecated: false
717
+ /services/scheduled/views/{name}/scheduled_times:
718
+ get:
719
+ tags:
720
+ - default
721
+ summary: getScheduledViewScheduledTimes
722
+ description: getScheduledViewScheduledTimes
723
+ operationId: getScheduledViewScheduledTimes
724
+ parameters:
725
+ - name: name
726
+ in: path
727
+ description: name
728
+ required: true
729
+ style: simple
730
+ schema:
731
+ type: string
732
+ - name: earliest_time
733
+ in: query
734
+ description: earliest_time
735
+ required: true
736
+ style: form
737
+ explode: true
738
+ schema:
739
+ type: string
740
+ - name: latest_time
741
+ in: query
742
+ description: latest_time
743
+ required: true
744
+ style: form
745
+ explode: true
746
+ schema:
747
+ type: string
748
+ responses:
749
+ '200':
750
+ description: successful operation
751
+ headers: {}
752
+ content: {}
753
+ '400':
754
+ description: failed operation
755
+ headers: {}
756
+ content: {}
757
+ deprecated: false
758
+ /services/search/jobs:
759
+ get:
760
+ tags:
761
+ - default
762
+ summary: getSearchJobs
763
+ description: getSearchJobs
764
+ operationId: getSearchJobs
765
+ parameters:
766
+ - name: count
767
+ in: query
768
+ description: count
769
+ required: true
770
+ style: form
771
+ explode: true
772
+ schema:
773
+ type: string
774
+ - name: f
775
+ in: query
776
+ description: f
777
+ required: true
778
+ style: form
779
+ explode: true
780
+ schema:
781
+ type: string
782
+ - name: offset
783
+ in: query
784
+ description: offset
785
+ required: true
786
+ style: form
787
+ explode: true
788
+ schema:
789
+ type: string
790
+ - name: search
791
+ in: query
792
+ description: search
793
+ required: true
794
+ style: form
795
+ explode: true
796
+ schema:
797
+ type: string
798
+ - name: sort_dir
799
+ in: query
800
+ description: sort_dir
801
+ required: true
802
+ style: form
803
+ explode: true
804
+ schema:
805
+ type: string
806
+ - name: sort_key
807
+ in: query
808
+ description: sort_key
809
+ required: true
810
+ style: form
811
+ explode: true
812
+ schema:
813
+ type: string
814
+ - name: sort_mode
815
+ in: query
816
+ description: sort_mode
817
+ required: true
818
+ style: form
819
+ explode: true
820
+ schema:
821
+ type: string
822
+ - name: summarize
823
+ in: query
824
+ description: summarize
825
+ required: true
826
+ style: form
827
+ explode: true
828
+ schema:
829
+ type: string
830
+ responses:
831
+ '200':
832
+ description: successful operation
833
+ headers: {}
834
+ content: {}
835
+ '400':
836
+ description: failed operation
837
+ headers: {}
838
+ content: {}
839
+ deprecated: false
840
+ post:
841
+ tags:
842
+ - default
843
+ summary: postSearchJobs
844
+ description: postSearchJobs
845
+ operationId: postSearchJobs
846
+ parameters: []
847
+ requestBody:
848
+ description: body
849
+ content:
850
+ '*/*':
851
+ schema:
852
+ description: body
853
+ example:
854
+ search_mode: realtime
855
+ indexedRealtime: 1
856
+ indexedRealtimeOffset: '300'
857
+ adhoc_search_level: verbose
858
+ auto_cancel: 0
859
+ auto_finalize_ec: 0
860
+ auto_pause: 0
861
+ id: id
862
+ max_count: 10000
863
+ namespace: namespace
864
+ example:
865
+ search_mode: realtime
866
+ indexedRealtime: 1
867
+ indexedRealtimeOffset: '300'
868
+ adhoc_search_level: verbose
869
+ auto_cancel: 0
870
+ auto_finalize_ec: 0
871
+ auto_pause: 0
872
+ id: id
873
+ max_count: 10000
874
+ namespace: namespace
875
+ required: true
876
+ responses:
877
+ '200':
878
+ description: successful operation
879
+ headers: {}
880
+ content: {}
881
+ '400':
882
+ description: failed operation
883
+ headers: {}
884
+ content: {}
885
+ deprecated: false
886
+ /services/search/jobs/export:
887
+ get:
888
+ tags:
889
+ - default
890
+ summary: getSearchJobsExport
891
+ description: getSearchJobsExport
892
+ operationId: getSearchJobsExport
893
+ parameters: []
894
+ responses:
895
+ '200':
896
+ description: successful operation
897
+ headers: {}
898
+ content: {}
899
+ '400':
900
+ description: failed operation
901
+ headers: {}
902
+ content: {}
903
+ deprecated: false
904
+ post:
905
+ tags:
906
+ - default
907
+ summary: postSearchJobsExport
908
+ description: postSearchJobsExport
909
+ operationId: postSearchJobsExport
910
+ parameters: []
911
+ requestBody:
912
+ description: body
913
+ content:
914
+ '*/*':
915
+ schema:
916
+ description: body
917
+ example:
918
+ search: string
919
+ auto_cancel: 0
920
+ auto_finalize_ec: 0
921
+ max_time: 100
922
+ rt_blocking: false
923
+ example:
924
+ search: string
925
+ auto_cancel: 0
926
+ auto_finalize_ec: 0
927
+ max_time: 100
928
+ rt_blocking: false
929
+ required: true
930
+ responses:
931
+ '200':
932
+ description: successful operation
933
+ headers: {}
934
+ content: {}
935
+ '400':
936
+ description: failed operation
937
+ headers: {}
938
+ content: {}
939
+ deprecated: false
940
+ /services/search/jobs/{search_id}:
941
+ delete:
942
+ tags:
943
+ - default
944
+ summary: deleteSearchJobsById
945
+ description: deleteSearchJobsById
946
+ operationId: deleteSearchJobsById
947
+ parameters:
948
+ - name: search_id
949
+ in: path
950
+ description: search_id
951
+ required: true
952
+ style: simple
953
+ schema:
954
+ type: string
955
+ responses:
956
+ '200':
957
+ description: successful operation
958
+ headers: {}
959
+ content: {}
960
+ '400':
961
+ description: failed operation
962
+ headers: {}
963
+ content: {}
964
+ deprecated: false
965
+ get:
966
+ tags:
967
+ - default
968
+ summary: getSearchJobsById
969
+ description: getSearchJobsById
970
+ operationId: getSearchJobsById
971
+ parameters:
972
+ - name: search_id
973
+ in: path
974
+ description: search_id
975
+ required: true
976
+ style: simple
977
+ schema:
978
+ type: string
979
+ responses:
980
+ '200':
981
+ description: successful operation
982
+ headers: {}
983
+ content: {}
984
+ '400':
985
+ description: failed operation
986
+ headers: {}
987
+ content: {}
988
+ deprecated: false
989
+ post:
990
+ tags:
991
+ - default
992
+ summary: postSearchJobsById
993
+ description: postSearchJobsById
994
+ operationId: postSearchJobsById
995
+ parameters:
996
+ - name: search_id
997
+ in: path
998
+ description: search_id
999
+ required: true
1000
+ style: simple
1001
+ schema:
1002
+ type: string
1003
+ requestBody:
1004
+ description: body
1005
+ content:
1006
+ '*/*':
1007
+ schema:
1008
+ description: body
1009
+ example:
1010
+ custom.*: string
1011
+ example:
1012
+ custom.*: string
1013
+ required: true
1014
+ responses:
1015
+ '200':
1016
+ description: successful operation
1017
+ headers: {}
1018
+ content: {}
1019
+ '400':
1020
+ description: failed operation
1021
+ headers: {}
1022
+ content: {}
1023
+ deprecated: false
1024
+ /services/search/jobs/{search_id}/control:
1025
+ post:
1026
+ tags:
1027
+ - default
1028
+ summary: postSearchJobsByIdControl
1029
+ description: postSearchJobsByIdControl
1030
+ operationId: postSearchJobsByIdControl
1031
+ parameters:
1032
+ - name: search_id
1033
+ in: path
1034
+ description: search_id
1035
+ required: true
1036
+ style: simple
1037
+ schema:
1038
+ type: string
1039
+ requestBody:
1040
+ description: body
1041
+ content:
1042
+ '*/*':
1043
+ schema:
1044
+ description: body
1045
+ example:
1046
+ action: finalize
1047
+ example:
1048
+ action: finalize
1049
+ required: true
1050
+ responses:
1051
+ '200':
1052
+ description: successful operation
1053
+ headers: {}
1054
+ content: {}
1055
+ '400':
1056
+ description: failed operation
1057
+ headers: {}
1058
+ content: {}
1059
+ deprecated: false
1060
+ /services/search/jobs/{search_id}/events:
1061
+ get:
1062
+ tags:
1063
+ - default
1064
+ summary: getSearchJobsByIdEvents
1065
+ description: getSearchJobsByIdEvents
1066
+ operationId: getSearchJobsByIdEvents
1067
+ parameters:
1068
+ - name: search_id
1069
+ in: path
1070
+ description: search_id
1071
+ required: true
1072
+ style: simple
1073
+ schema:
1074
+ type: string
1075
+ - name: count
1076
+ in: query
1077
+ description: count
1078
+ required: true
1079
+ style: form
1080
+ explode: true
1081
+ schema:
1082
+ type: string
1083
+ - name: max_lines
1084
+ in: query
1085
+ description: max_lines
1086
+ required: true
1087
+ style: form
1088
+ explode: true
1089
+ schema:
1090
+ type: string
1091
+ - name: output_mode
1092
+ in: query
1093
+ description: output_mode
1094
+ required: true
1095
+ style: form
1096
+ explode: true
1097
+ schema:
1098
+ type: string
1099
+ - name: truncation_mode
1100
+ in: query
1101
+ description: truncation_mode
1102
+ required: true
1103
+ style: form
1104
+ explode: true
1105
+ schema:
1106
+ type: string
1107
+ responses:
1108
+ '200':
1109
+ description: successful operation
1110
+ headers: {}
1111
+ content: {}
1112
+ '400':
1113
+ description: failed operation
1114
+ headers: {}
1115
+ content: {}
1116
+ deprecated: false
1117
+ /services/search/jobs/{search_id}/results:
1118
+ get:
1119
+ tags:
1120
+ - default
1121
+ summary: getSearchJobsByIdResults
1122
+ description: getSearchJobsByIdResults
1123
+ operationId: getSearchJobsByIdResults
1124
+ parameters:
1125
+ - name: search_id
1126
+ in: path
1127
+ description: search_id
1128
+ required: true
1129
+ style: simple
1130
+ schema:
1131
+ type: string
1132
+ - name: count
1133
+ in: query
1134
+ description: count
1135
+ required: true
1136
+ style: form
1137
+ explode: true
1138
+ schema:
1139
+ type: string
1140
+ - name: add_summary_to_metadata
1141
+ in: query
1142
+ description: add_summary_to_metadata
1143
+ required: true
1144
+ style: form
1145
+ explode: true
1146
+ schema:
1147
+ type: string
1148
+ - name: search
1149
+ in: query
1150
+ description: search
1151
+ required: true
1152
+ style: form
1153
+ explode: true
1154
+ schema:
1155
+ type: string
1156
+ responses:
1157
+ '200':
1158
+ description: successful operation
1159
+ headers: {}
1160
+ content: {}
1161
+ '400':
1162
+ description: failed operation
1163
+ headers: {}
1164
+ content: {}
1165
+ deprecated: false
1166
+ /services/search/jobs/{search_id}/results_preview:
1167
+ get:
1168
+ tags:
1169
+ - default
1170
+ summary: getSearchJobsByIdResultsPreview
1171
+ description: getSearchJobsByIdResultsPreview
1172
+ operationId: getSearchJobsByIdResultsPreview
1173
+ parameters:
1174
+ - name: search_id
1175
+ in: path
1176
+ description: search_id
1177
+ required: true
1178
+ style: simple
1179
+ schema:
1180
+ type: string
1181
+ - name: count
1182
+ in: query
1183
+ description: count
1184
+ required: true
1185
+ style: form
1186
+ explode: true
1187
+ schema:
1188
+ type: string
1189
+ - name: add_summary_to_metadata
1190
+ in: query
1191
+ description: add_summary_to_metadata
1192
+ required: true
1193
+ style: form
1194
+ explode: true
1195
+ schema:
1196
+ type: string
1197
+ - name: search
1198
+ in: query
1199
+ description: search
1200
+ required: true
1201
+ style: form
1202
+ explode: true
1203
+ schema:
1204
+ type: string
1205
+ responses:
1206
+ '200':
1207
+ description: successful operation
1208
+ headers: {}
1209
+ content: {}
1210
+ '400':
1211
+ description: failed operation
1212
+ headers: {}
1213
+ content: {}
1214
+ deprecated: false
1215
+ /services/search/jobs/{search_id}/search.log:
1216
+ get:
1217
+ tags:
1218
+ - default
1219
+ summary: getSearchJobsSearchLogs
1220
+ description: getSearchJobsSearchLogs
1221
+ operationId: getSearchJobsSearchLogs
1222
+ parameters:
1223
+ - name: search_id
1224
+ in: path
1225
+ description: search_id
1226
+ required: true
1227
+ style: simple
1228
+ schema:
1229
+ type: string
1230
+ - name: attachment
1231
+ in: query
1232
+ description: attachment
1233
+ required: true
1234
+ style: form
1235
+ explode: true
1236
+ schema:
1237
+ type: string
1238
+ responses:
1239
+ '200':
1240
+ description: successful operation
1241
+ headers: {}
1242
+ content: {}
1243
+ '400':
1244
+ description: failed operation
1245
+ headers: {}
1246
+ content: {}
1247
+ deprecated: false
1248
+ /services/search/jobs/{search_id}/summary:
1249
+ get:
1250
+ tags:
1251
+ - default
1252
+ summary: getSearchJobsbyIdSummary
1253
+ description: getSearchJobsbyIdSummary
1254
+ operationId: getSearchJobsbyIdSummary
1255
+ parameters:
1256
+ - name: search_id
1257
+ in: path
1258
+ description: search_id
1259
+ required: true
1260
+ style: simple
1261
+ schema:
1262
+ type: string
1263
+ responses:
1264
+ '200':
1265
+ description: successful operation
1266
+ headers: {}
1267
+ content: {}
1268
+ '400':
1269
+ description: failed operation
1270
+ headers: {}
1271
+ content: {}
1272
+ deprecated: false
1273
+ /services/search/jobs/{search_id}/timeline:
1274
+ get:
1275
+ tags:
1276
+ - default
1277
+ summary: getSearchJobsByIdTimeline
1278
+ description: getSearchJobsByIdTimeline
1279
+ operationId: getSearchJobsByIdTimeline
1280
+ parameters:
1281
+ - name: search_id
1282
+ in: path
1283
+ description: search_id
1284
+ required: true
1285
+ style: simple
1286
+ schema:
1287
+ type: string
1288
+ - name: output_time_format
1289
+ in: query
1290
+ description: output_time_format
1291
+ required: true
1292
+ style: form
1293
+ explode: true
1294
+ schema:
1295
+ type: string
1296
+ - name: time_format
1297
+ in: query
1298
+ description: time_format
1299
+ required: true
1300
+ style: form
1301
+ explode: true
1302
+ schema:
1303
+ type: string
1304
+ responses:
1305
+ '200':
1306
+ description: successful operation
1307
+ headers: {}
1308
+ content: {}
1309
+ '400':
1310
+ description: failed operation
1311
+ headers: {}
1312
+ content: {}
1313
+ deprecated: false
1314
+ /services/search/parser:
1315
+ get:
1316
+ tags:
1317
+ - default
1318
+ summary: getSearchParser
1319
+ description: getSearchParser
1320
+ operationId: getSearchParser
1321
+ parameters:
1322
+ - name: q
1323
+ in: query
1324
+ description: q
1325
+ required: true
1326
+ style: form
1327
+ explode: true
1328
+ schema:
1329
+ type: string
1330
+ responses:
1331
+ '200':
1332
+ description: successful operation
1333
+ headers: {}
1334
+ content: {}
1335
+ '400':
1336
+ description: failed operation
1337
+ headers: {}
1338
+ content: {}
1339
+ deprecated: false
1340
+ /services/search/scheduler:
1341
+ get:
1342
+ tags:
1343
+ - default
1344
+ summary: getSearchScheduler
1345
+ description: getSearchScheduler
1346
+ operationId: getSearchScheduler
1347
+ parameters: []
1348
+ responses:
1349
+ '200':
1350
+ description: successful operation
1351
+ headers: {}
1352
+ content: {}
1353
+ '400':
1354
+ description: failed operation
1355
+ headers: {}
1356
+ content: {}
1357
+ deprecated: false
1358
+ /services/search/scheduler/status:
1359
+ post:
1360
+ tags:
1361
+ - default
1362
+ summary: postSearchSchedulerStatus
1363
+ description: postSearchSchedulerStatus
1364
+ operationId: postSearchSchedulerStatus
1365
+ parameters: []
1366
+ requestBody:
1367
+ description: body
1368
+ content:
1369
+ '*/*':
1370
+ schema:
1371
+ description: body
1372
+ example:
1373
+ disabled: false
1374
+ example:
1375
+ disabled: false
1376
+ required: true
1377
+ responses:
1378
+ '200':
1379
+ description: successful operation
1380
+ headers: {}
1381
+ content: {}
1382
+ '400':
1383
+ description: failed operation
1384
+ headers: {}
1385
+ content: {}
1386
+ deprecated: false
1387
+ /services/search/timeparse:
1388
+ get:
1389
+ tags:
1390
+ - default
1391
+ summary: getSearchTimerParser
1392
+ description: getSearchTimerParser
1393
+ operationId: getSearchTimerParser
1394
+ parameters:
1395
+ - name: time
1396
+ in: query
1397
+ description: time
1398
+ required: true
1399
+ style: form
1400
+ explode: true
1401
+ schema:
1402
+ type: string
1403
+ responses:
1404
+ '200':
1405
+ description: successful operation
1406
+ headers: {}
1407
+ content: {}
1408
+ '400':
1409
+ description: failed operation
1410
+ headers: {}
1411
+ content: {}
1412
+ deprecated: false
1413
+ /services/search/typeahead:
1414
+ get:
1415
+ tags:
1416
+ - default
1417
+ summary: getSearchTypeHead
1418
+ description: getSearchTypeHead
1419
+ operationId: getSearchTypeHead
1420
+ parameters:
1421
+ - name: count
1422
+ in: query
1423
+ description: count
1424
+ required: true
1425
+ style: form
1426
+ explode: true
1427
+ schema:
1428
+ type: string
1429
+ - name: prefix
1430
+ in: query
1431
+ description: prefix
1432
+ required: true
1433
+ style: form
1434
+ explode: true
1435
+ schema:
1436
+ type: string
1437
+ responses:
1438
+ '200':
1439
+ description: successful operation
1440
+ headers: {}
1441
+ content: {}
1442
+ '400':
1443
+ description: failed operation
1444
+ headers: {}
1445
+ content: {}
1446
+ deprecated: false
1447
+ /services/admin/-/alerts/alert_actions:
1448
+ get:
1449
+ tags:
1450
+ - default
1451
+ summary: getAlertActions
1452
+ description: getAlertActions
1453
+ operationId: getAlertActions
1454
+ parameters:
1455
+ - name: count
1456
+ in: query
1457
+ description: count
1458
+ required: true
1459
+ style: form
1460
+ explode: true
1461
+ schema:
1462
+ type: string
1463
+ - name: f
1464
+ in: query
1465
+ description: f
1466
+ required: true
1467
+ style: form
1468
+ explode: true
1469
+ schema:
1470
+ type: string
1471
+ - name: offset
1472
+ in: query
1473
+ description: offset
1474
+ required: true
1475
+ style: form
1476
+ explode: true
1477
+ schema:
1478
+ type: string
1479
+ - name: search
1480
+ in: query
1481
+ description: search
1482
+ required: true
1483
+ style: form
1484
+ explode: true
1485
+ schema:
1486
+ type: string
1487
+ - name: sort_dir
1488
+ in: query
1489
+ description: sort_dir
1490
+ required: true
1491
+ style: form
1492
+ explode: true
1493
+ schema:
1494
+ type: string
1495
+ - name: sort_key
1496
+ in: query
1497
+ description: sort_key
1498
+ required: true
1499
+ style: form
1500
+ explode: true
1501
+ schema:
1502
+ type: string
1503
+ - name: sort_mode
1504
+ in: query
1505
+ description: sort_mode
1506
+ required: true
1507
+ style: form
1508
+ explode: true
1509
+ schema:
1510
+ type: string
1511
+ - name: summarize
1512
+ in: query
1513
+ description: summarize
1514
+ required: true
1515
+ style: form
1516
+ explode: true
1517
+ schema:
1518
+ type: string
1519
+ responses:
1520
+ '200':
1521
+ description: successful operation
1522
+ headers: {}
1523
+ content: {}
1524
+ '400':
1525
+ description: failed operation
1526
+ headers: {}
1527
+ content: {}
1528
+ deprecated: false
1529
+ /services/admin/search/alerts/fired_alerts:
1530
+ get:
1531
+ tags:
1532
+ - default
1533
+ summary: getFiredAlerts
1534
+ description: getFiredAlerts
1535
+ operationId: getFiredAlerts
1536
+ parameters:
1537
+ - name: count
1538
+ in: query
1539
+ description: count
1540
+ required: true
1541
+ style: form
1542
+ explode: true
1543
+ schema:
1544
+ type: string
1545
+ - name: f
1546
+ in: query
1547
+ description: f
1548
+ required: true
1549
+ style: form
1550
+ explode: true
1551
+ schema:
1552
+ type: string
1553
+ - name: offset
1554
+ in: query
1555
+ description: offset
1556
+ required: true
1557
+ style: form
1558
+ explode: true
1559
+ schema:
1560
+ type: string
1561
+ - name: search
1562
+ in: query
1563
+ description: search
1564
+ required: true
1565
+ style: form
1566
+ explode: true
1567
+ schema:
1568
+ type: string
1569
+ - name: sort_dir
1570
+ in: query
1571
+ description: sort_dir
1572
+ required: true
1573
+ style: form
1574
+ explode: true
1575
+ schema:
1576
+ type: string
1577
+ - name: sort_key
1578
+ in: query
1579
+ description: sort_key
1580
+ required: true
1581
+ style: form
1582
+ explode: true
1583
+ schema:
1584
+ type: string
1585
+ - name: sort_mode
1586
+ in: query
1587
+ description: sort_mode
1588
+ required: true
1589
+ style: form
1590
+ explode: true
1591
+ schema:
1592
+ type: string
1593
+ - name: summarize
1594
+ in: query
1595
+ description: summarize
1596
+ required: true
1597
+ style: form
1598
+ explode: true
1599
+ schema:
1600
+ type: string
1601
+ responses:
1602
+ '200':
1603
+ description: successful operation
1604
+ headers: {}
1605
+ content: {}
1606
+ '400':
1607
+ description: failed operation
1608
+ headers: {}
1609
+ content: {}
1610
+ deprecated: false
1611
+ /services/admin/search/alerts/fired_alerts/{name}:
1612
+ get:
1613
+ tags:
1614
+ - default
1615
+ summary: getFiredAlertsbyName
1616
+ description: getFiredAlertsbyName
1617
+ operationId: getFiredAlertsbyName
1618
+ parameters:
1619
+ - name: name
1620
+ in: path
1621
+ description: name
1622
+ required: true
1623
+ style: simple
1624
+ schema:
1625
+ type: string
1626
+ responses:
1627
+ '200':
1628
+ description: successful operation
1629
+ headers: {}
1630
+ content: {}
1631
+ '400':
1632
+ description: failed operation
1633
+ headers: {}
1634
+ content: {}
1635
+ deprecated: false
1636
+ delete:
1637
+ tags:
1638
+ - default
1639
+ summary: deleteFiredAlertsByName
1640
+ description: deleteFiredAlertsByName
1641
+ operationId: deleteFiredAlertsByName
1642
+ parameters:
1643
+ - name: name
1644
+ in: path
1645
+ description: name
1646
+ required: true
1647
+ style: simple
1648
+ schema:
1649
+ type: string
1650
+ responses:
1651
+ '200':
1652
+ description: successful operation
1653
+ headers: {}
1654
+ content: {}
1655
+ '400':
1656
+ description: failed operation
1657
+ headers: {}
1658
+ content: {}
1659
+ deprecated: false
1660
+ /services/nobody/search/data/commands:
1661
+ get:
1662
+ tags:
1663
+ - default
1664
+ summary: getDataCommands
1665
+ description: getDataCommands
1666
+ operationId: getDataCommands
1667
+ parameters: []
1668
+ responses:
1669
+ '200':
1670
+ description: successful operation
1671
+ headers: {}
1672
+ content: {}
1673
+ '400':
1674
+ description: failed operation
1675
+ headers: {}
1676
+ content: {}
1677
+ deprecated: false
1678
+ components:
1679
+ schemas:
1680
+ Content-Type:
1681
+ title: Content-Type
1682
+ enum:
1683
+ - '*/*'
1684
+ type: string
1685
+ tags:
1686
+ - name: default
1687
+ description: ''
1688
+ externalDocs:
1689
+ description: Find out more about the OpenAPI Initiative
1690
+ url: https://www.openapis.org/