@itentialopensource/adapter-kentik_v5 0.1.2 → 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.
@@ -0,0 +1,3463 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: Kentik V5 API (https://api.kentik.com/api/v5/)
4
+ contact: {}
5
+ version: '1.0'
6
+ servers:
7
+ - url: https://api.kentik.com/api/v5
8
+ variables: {}
9
+ paths:
10
+ /query/sql:
11
+ post:
12
+ tags:
13
+ - Query Methods
14
+ summary: runQuery
15
+ description: This method allows you to run a SQL command against all configured devices. <a href='https://kb.kentik.com/Ec04.htm#Ec04-Query_SQL_Method' target='_blank'>Documentation</a>.
16
+ operationId: runQuery
17
+ parameters: []
18
+ requestBody:
19
+ description: ''
20
+ content:
21
+ application/json:
22
+ schema:
23
+ $ref: '#/components/schemas/runQuery'
24
+ required: true
25
+ responses:
26
+ '200':
27
+ description: ''
28
+ headers: {}
29
+ content:
30
+ application/json:
31
+ schema:
32
+ type: object
33
+ deprecated: false
34
+ /query/url:
35
+ post:
36
+ tags:
37
+ - Query Methods
38
+ summary: queryUrl
39
+ description: Returns a URL to view a given query in Data Explorer. <a href='https://kb.kentik.com/Ec04.htm#Ec04-Query_URL_Method' target='_blank'>Documentation</a>.
40
+ operationId: queryUrl
41
+ parameters: []
42
+ requestBody:
43
+ description: ''
44
+ content:
45
+ application/json:
46
+ schema:
47
+ $ref: '#/components/schemas/queryUrl'
48
+ required: true
49
+ responses:
50
+ '200':
51
+ description: ''
52
+ headers: {}
53
+ content:
54
+ application/json:
55
+ schema:
56
+ type: object
57
+ deprecated: false
58
+ /query/topxdata:
59
+ post:
60
+ tags:
61
+ - Query Methods
62
+ summary: topxdata
63
+ description: Returns query results in JSON that can be parsed to generate a TopX table. <a href='https://kb.kentik.com/Ec04.htm#Ec04-Query_Data_Method' target='_blank'>Documentation</a>.
64
+ operationId: topxdata
65
+ parameters: []
66
+ requestBody:
67
+ description: ''
68
+ content:
69
+ application/json:
70
+ schema:
71
+ $ref: '#/components/schemas/topxdata'
72
+ required: true
73
+ responses:
74
+ '200':
75
+ description: ''
76
+ headers: {}
77
+ content:
78
+ application/json:
79
+ schema:
80
+ type: object
81
+ deprecated: false
82
+ /query/topxchart:
83
+ post:
84
+ tags:
85
+ - Query Methods
86
+ summary: topxchart
87
+ description: Returns an image of a graph similar to what is seen in the Kentik portal's Data Explorer. <a href='https://kb.kentik.com/Ec04.htm#Ec04-Query_Chart_Method' target='_blank'>Documentation</a>.
88
+ operationId: topxchart
89
+ parameters: []
90
+ requestBody:
91
+ description: ''
92
+ content:
93
+ application/json:
94
+ schema:
95
+ $ref: '#/components/schemas/topxchart'
96
+ required: true
97
+ responses:
98
+ '200':
99
+ description: ''
100
+ headers: {}
101
+ content:
102
+ application/json:
103
+ schema:
104
+ type: object
105
+ deprecated: false
106
+ /users:
107
+ get:
108
+ tags:
109
+ - user
110
+ summary: findUsers
111
+ description: Returns an array of user objects, each of which contains information about an individual user (see <a href='https://kb.kentik.com/Cb02.htm#Cb02-User_Field_Definitions' target='_blank'>User Field Definitions</a>).<br/>* Required fields.
112
+ operationId: findUsers
113
+ parameters: []
114
+ responses:
115
+ '200':
116
+ description: ''
117
+ headers: {}
118
+ content:
119
+ application/json:
120
+ schema:
121
+ type: object
122
+ deprecated: false
123
+ /user/{user_id}:
124
+ get:
125
+ tags:
126
+ - user
127
+ summary: findUser
128
+ description: Returns a user object containing information about an individual user (see <a href='https://kb.kentik.com/Cb02.htm#Cb02-User_Field_Definitions' target='_blank'>User Field Definitions</a>).<br/>* Required fields.
129
+ operationId: findUser
130
+ parameters:
131
+ - name: user_id
132
+ in: path
133
+ description: The ID of the user whose information will be returned.
134
+ required: true
135
+ style: simple
136
+ schema:
137
+ type: integer
138
+ format: int32
139
+ responses:
140
+ '200':
141
+ description: ''
142
+ headers: {}
143
+ content:
144
+ application/json:
145
+ schema:
146
+ type: object
147
+ deprecated: false
148
+ put:
149
+ tags:
150
+ - user
151
+ summary: updateUser
152
+ description: Updates and returns a user object containing information about an individual user (see <a href='https://kb.kentik.com/Cb02.htm#Cb02-User_Field_Definitions' target='_blank'>User Field Definitions</a>).<br/>* Required fields.
153
+ operationId: updateUser
154
+ parameters:
155
+ - name: user_id
156
+ in: path
157
+ description: The ID of the user whose information will be updated.
158
+ required: true
159
+ style: simple
160
+ schema:
161
+ type: integer
162
+ format: int32
163
+ requestBody:
164
+ description: ''
165
+ content:
166
+ application/json:
167
+ schema:
168
+ $ref: '#/components/schemas/updateUser'
169
+ required: true
170
+ responses:
171
+ '200':
172
+ description: ''
173
+ headers: {}
174
+ content:
175
+ application/json:
176
+ schema:
177
+ type: object
178
+ deprecated: false
179
+ delete:
180
+ tags:
181
+ - user
182
+ summary: deleteUser
183
+ description: Deletes a user from the system.<br/>* Required fields.
184
+ operationId: deleteUser
185
+ parameters:
186
+ - name: user_id
187
+ in: path
188
+ description: The id of the user to delete.
189
+ required: true
190
+ style: simple
191
+ schema:
192
+ type: integer
193
+ format: int32
194
+ responses:
195
+ '200':
196
+ description: ''
197
+ headers: {}
198
+ content:
199
+ application/json:
200
+ schema:
201
+ type: object
202
+ deprecated: false
203
+ /user:
204
+ post:
205
+ tags:
206
+ - user
207
+ summary: createUser
208
+ description: Creates and returns a user object containing information about an individual user (see <a href='https://kb.kentik.com/Cb02.htm#Cb02-User_Field_Definitions' target='_blank'>User Field Definitions</a>).<br/>* Required fields.
209
+ operationId: createUser
210
+ parameters: []
211
+ requestBody:
212
+ description: ''
213
+ content:
214
+ application/json:
215
+ schema:
216
+ $ref: '#/components/schemas/createUser'
217
+ required: true
218
+ responses:
219
+ '200':
220
+ description: ''
221
+ headers: {}
222
+ content:
223
+ application/json:
224
+ schema:
225
+ type: object
226
+ deprecated: false
227
+ /devices:
228
+ get:
229
+ tags:
230
+ - device
231
+ summary: findDevices
232
+ description: Returns an array of device objects that each contain information about an individual device (see <a href='https://kb.kentik.com/Cb01.htm#Cb01-About_Devices' target='_blank'>About Devices</a>).<br/>* Required fields.
233
+ operationId: findDevices
234
+ parameters: []
235
+ responses:
236
+ '200':
237
+ description: ''
238
+ headers: {}
239
+ content:
240
+ application/json:
241
+ schema:
242
+ type: object
243
+ deprecated: false
244
+ /device/{device_id}:
245
+ get:
246
+ tags:
247
+ - device
248
+ summary: findDevice
249
+ description: Returns a device object containing information about an individual device (see <a href='https://kb.kentik.com/Cb01.htm#Cb01-About_Devices' target='_blank'>About Devices</a>).<br/>* Required fields.
250
+ operationId: findDevice
251
+ parameters:
252
+ - name: device_id
253
+ in: path
254
+ description: The id of the device whose information will be returned.
255
+ required: true
256
+ style: simple
257
+ schema:
258
+ type: integer
259
+ format: int32
260
+ responses:
261
+ '200':
262
+ description: ''
263
+ headers: {}
264
+ content:
265
+ application/json:
266
+ schema:
267
+ type: object
268
+ deprecated: false
269
+ put:
270
+ tags:
271
+ - device
272
+ summary: updateDevice
273
+ description: Updates and returns a device object containing information about an individual device (see <a href='https://kb.kentik.com/Cb01.htm#Cb01-About_Devices' target='_blank'>About Devices</a>).<br/>* Required fields.
274
+ operationId: updateDevice
275
+ parameters:
276
+ - name: device_id
277
+ in: path
278
+ description: The id of the device whose information will be updated.
279
+ required: true
280
+ style: simple
281
+ schema:
282
+ type: integer
283
+ format: int32
284
+ requestBody:
285
+ description: ''
286
+ content:
287
+ application/json:
288
+ schema:
289
+ $ref: '#/components/schemas/updateDevice'
290
+ required: true
291
+ responses:
292
+ '200':
293
+ description: ''
294
+ headers: {}
295
+ content:
296
+ application/json:
297
+ schema:
298
+ type: object
299
+ deprecated: false
300
+ delete:
301
+ tags:
302
+ - device
303
+ summary: deleteDevice
304
+ description: Deletes a device.<br/>* Required fields.
305
+ operationId: deleteDevice
306
+ parameters:
307
+ - name: device_id
308
+ in: path
309
+ description: The id of the device to delete.
310
+ required: true
311
+ style: simple
312
+ schema:
313
+ type: integer
314
+ format: int32
315
+ responses:
316
+ '200':
317
+ description: ''
318
+ headers: {}
319
+ content:
320
+ application/json:
321
+ schema:
322
+ type: object
323
+ deprecated: false
324
+ /device:
325
+ post:
326
+ tags:
327
+ - device
328
+ summary: createDevice
329
+ description: Creates and returns a device object containing information about an individual device (see <a href='https://kb.kentik.com/Cb01.htm#Cb01-About_Devices' target='_blank'>About Devices</a>).<br/>* Required fields.<br/>** Conditionally required fields.
330
+ operationId: createDevice
331
+ parameters: []
332
+ requestBody:
333
+ description: ''
334
+ content:
335
+ application/json:
336
+ schema:
337
+ $ref: '#/components/schemas/createDevice'
338
+ required: true
339
+ responses:
340
+ '200':
341
+ description: ''
342
+ headers: {}
343
+ content:
344
+ application/json:
345
+ schema:
346
+ type: object
347
+ deprecated: false
348
+ /devices/{device_id}/labels:
349
+ put:
350
+ tags:
351
+ - device
352
+ summary: deviceApplyLabels
353
+ description: Removes all existing labels from the device and applies the device labels (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-About_Device_Labels' target='_blank'>About Device Labels</a>) specified by id. Returns a reduced version<br/>of device object containing an array of the applied labels.<br/>* Required fields.
354
+ operationId: deviceApplyLabels
355
+ parameters:
356
+ - name: device_id
357
+ in: path
358
+ description: The id of the device whose labels will be applied.
359
+ required: true
360
+ style: simple
361
+ schema:
362
+ type: integer
363
+ format: int32
364
+ requestBody:
365
+ description: ''
366
+ content:
367
+ application/json:
368
+ schema:
369
+ $ref: '#/components/schemas/deviceApplyLabels'
370
+ required: true
371
+ responses:
372
+ '200':
373
+ description: ''
374
+ headers: {}
375
+ content:
376
+ application/json:
377
+ schema:
378
+ type: object
379
+ deprecated: false
380
+ /device/{device_id}/interfaces:
381
+ get:
382
+ tags:
383
+ - device
384
+ summary: findInterfaces
385
+ description: Returns an array of interface objects that each contain information about an interface from a specified device.<br/>* Required fields.
386
+ operationId: findInterfaces
387
+ parameters:
388
+ - name: device_id
389
+ in: path
390
+ description: The id of the device whose interfaces will be returned.
391
+ required: true
392
+ style: simple
393
+ schema:
394
+ type: integer
395
+ format: int32
396
+ responses:
397
+ '200':
398
+ description: ''
399
+ headers: {}
400
+ content:
401
+ application/json:
402
+ schema:
403
+ type: object
404
+ deprecated: false
405
+ /device/{device_id}/interface/{interface_id}:
406
+ get:
407
+ tags:
408
+ - device
409
+ summary: findInterface
410
+ description: Returns a interface object containing information about an individual interface from a given device.<br/>* Required fields.
411
+ operationId: findInterface
412
+ parameters:
413
+ - name: device_id
414
+ in: path
415
+ description: The id of the device whose interface information will be returned.
416
+ required: true
417
+ style: simple
418
+ schema:
419
+ type: integer
420
+ format: int32
421
+ - name: interface_id
422
+ in: path
423
+ description: The id of the interface whose information will be returned. This is NOT the same as the interface's SNMP ID.
424
+ required: true
425
+ style: simple
426
+ schema:
427
+ type: integer
428
+ format: int32
429
+ responses:
430
+ '200':
431
+ description: ''
432
+ headers: {}
433
+ content:
434
+ application/json:
435
+ schema:
436
+ type: object
437
+ deprecated: false
438
+ put:
439
+ tags:
440
+ - device
441
+ summary: updateInterface
442
+ description: Updates and returns an interface object containing information about an individual interface from a specified device.<br/>* Required fields.<br/>*** Alternatively, instead of defining a vrf object, you can add the vrf_id.
443
+ operationId: updateInterface
444
+ parameters:
445
+ - name: device_id
446
+ in: path
447
+ description: The id of the device whose interface information will be updated.
448
+ required: true
449
+ style: simple
450
+ schema:
451
+ type: integer
452
+ format: int32
453
+ - name: interface_id
454
+ in: path
455
+ description: The id of the interface whose information will be updated. This is NOT the same as the SNMP ID.
456
+ required: true
457
+ style: simple
458
+ schema:
459
+ type: integer
460
+ format: int32
461
+ requestBody:
462
+ description: ''
463
+ content:
464
+ application/json:
465
+ schema:
466
+ $ref: '#/components/schemas/updateInterface'
467
+ required: true
468
+ responses:
469
+ '200':
470
+ description: ''
471
+ headers: {}
472
+ content:
473
+ application/json:
474
+ schema:
475
+ type: object
476
+ deprecated: false
477
+ delete:
478
+ tags:
479
+ - device
480
+ summary: deleteInterface
481
+ description: Deletes an interface from a given device.<br/>* Required fields.
482
+ operationId: deleteInterface
483
+ parameters:
484
+ - name: device_id
485
+ in: path
486
+ description: The id of the device from which to delete the specified interface.
487
+ required: true
488
+ style: simple
489
+ schema:
490
+ type: integer
491
+ format: int32
492
+ - name: interface_id
493
+ in: path
494
+ description: The id of the interface to delete from the specified device.
495
+ required: true
496
+ style: simple
497
+ schema:
498
+ type: integer
499
+ format: int32
500
+ responses:
501
+ '200':
502
+ description: ''
503
+ headers: {}
504
+ content:
505
+ application/json:
506
+ schema:
507
+ type: object
508
+ deprecated: false
509
+ /device/{device_id}/interface:
510
+ post:
511
+ tags:
512
+ - device
513
+ summary: createInterface
514
+ description: Creates and returns an interface object containing information about an individual interface for a given device.<br/>* Required fields.<br/>*** Alternatively, instead of defining a vrf object, you can add the vrf_id.
515
+ operationId: createInterface
516
+ parameters:
517
+ - name: device_id
518
+ in: path
519
+ description: The id of the device to which you want to add an interface.
520
+ required: true
521
+ style: simple
522
+ schema:
523
+ type: integer
524
+ format: int32
525
+ requestBody:
526
+ description: ''
527
+ content:
528
+ application/json:
529
+ schema:
530
+ $ref: '#/components/schemas/createInterface'
531
+ required: true
532
+ responses:
533
+ '200':
534
+ description: ''
535
+ headers: {}
536
+ content:
537
+ application/json:
538
+ schema:
539
+ type: object
540
+ deprecated: false
541
+ /deviceLabels:
542
+ get:
543
+ tags:
544
+ - device label
545
+ summary: findDeviceLabels
546
+ description: Returns an array of device label objects that each contain information about an individual device label (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-Device_Labels' target='_blank'>Device Labels</a>).<br/>* Required fields.
547
+ operationId: findDeviceLabels
548
+ parameters: []
549
+ responses:
550
+ '200':
551
+ description: ''
552
+ headers: {}
553
+ content:
554
+ application/json:
555
+ schema:
556
+ type: object
557
+ deprecated: false
558
+ post:
559
+ tags:
560
+ - device label
561
+ summary: createDeviceLabel
562
+ description: Creates and returns a device label object containing information about an individual device label (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-Device_Labels' target='_blank'>Device Labels</a>).<br/>* Required fields.<br/>** Conditionally required fields.
563
+ operationId: createDeviceLabel
564
+ parameters: []
565
+ requestBody:
566
+ description: ''
567
+ content:
568
+ application/json:
569
+ schema:
570
+ $ref: '#/components/schemas/createDeviceLabel'
571
+ required: true
572
+ responses:
573
+ '200':
574
+ description: ''
575
+ headers: {}
576
+ content:
577
+ application/json:
578
+ schema:
579
+ type: object
580
+ deprecated: false
581
+ /deviceLabels/{device_label_id}:
582
+ get:
583
+ tags:
584
+ - device label
585
+ summary: findDeviceLabel
586
+ description: Returns a device label object containing information about an individual device label (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-Device_Labels' target='_blank'>Device Labels</a>).<br/>* Required fields.
587
+ operationId: findDeviceLabel
588
+ parameters:
589
+ - name: device_label_id
590
+ in: path
591
+ description: The id of the device label whose information will be returned.
592
+ required: true
593
+ style: simple
594
+ schema:
595
+ type: integer
596
+ format: int32
597
+ responses:
598
+ '200':
599
+ description: ''
600
+ headers: {}
601
+ content:
602
+ application/json:
603
+ schema:
604
+ type: object
605
+ deprecated: false
606
+ put:
607
+ tags:
608
+ - device label
609
+ summary: updateDeviceLabel
610
+ description: Updates and returns a device label object containing information about an individual device label (see <a href='https://kb.kentik.com/Cb16.htm#Cb16-Device_Labels' target='_blank'>Device Labels</a>).<br/>* Required fields.
611
+ operationId: updateDeviceLabel
612
+ parameters:
613
+ - name: device_label_id
614
+ in: path
615
+ description: The id of the device label whose information will be updated.
616
+ required: true
617
+ style: simple
618
+ schema:
619
+ type: integer
620
+ format: int32
621
+ requestBody:
622
+ description: ''
623
+ content:
624
+ application/json:
625
+ schema:
626
+ $ref: '#/components/schemas/updateDeviceLabel'
627
+ required: true
628
+ responses:
629
+ '200':
630
+ description: ''
631
+ headers: {}
632
+ content:
633
+ application/json:
634
+ schema:
635
+ type: object
636
+ deprecated: false
637
+ delete:
638
+ tags:
639
+ - device label
640
+ summary: deleteDeviceLabel
641
+ description: Deletes a device label.<br/>* Required fields.
642
+ operationId: deleteDeviceLabel
643
+ parameters:
644
+ - name: device_label_id
645
+ in: path
646
+ description: The id of the device label to delete.
647
+ required: true
648
+ style: simple
649
+ schema:
650
+ type: integer
651
+ format: int32
652
+ responses:
653
+ '200':
654
+ description: ''
655
+ headers: {}
656
+ content:
657
+ application/json:
658
+ schema:
659
+ type: object
660
+ deprecated: false
661
+ /plans:
662
+ get:
663
+ tags:
664
+ - plan
665
+ summary: findPlans
666
+ description: Returns an array of plan objects, each of which contains information about an individual plan.
667
+ operationId: findPlans
668
+ parameters: []
669
+ responses:
670
+ '200':
671
+ description: ''
672
+ headers: {}
673
+ content:
674
+ application/json:
675
+ schema:
676
+ type: object
677
+ deprecated: false
678
+ /sites:
679
+ get:
680
+ tags:
681
+ - site
682
+ summary: findSites
683
+ description: Returns an array of site objects, each of which contains information about an individual site (see <a href='https://kb.kentik.com/Cb13.htm#Cb13-About_Sites' target='_blank'>About Sites</a>).<br/>* Required fields.
684
+ operationId: findSites
685
+ parameters: []
686
+ responses:
687
+ '200':
688
+ description: ''
689
+ headers: {}
690
+ content:
691
+ application/json:
692
+ schema:
693
+ type: object
694
+ deprecated: false
695
+ /site/{site_id}:
696
+ get:
697
+ tags:
698
+ - site
699
+ summary: findSite
700
+ description: Returns a site object containing information about an individual site (see <a href='https://kb.kentik.com/Cb13.htm#Cb13-About_Sites' target='_blank'>About Sites</a>).<br/>* Required fields.
701
+ operationId: findSite
702
+ parameters:
703
+ - name: site_id
704
+ in: path
705
+ description: The ID of the site whose information will be returned.
706
+ required: true
707
+ style: simple
708
+ schema:
709
+ type: integer
710
+ format: int32
711
+ responses:
712
+ '200':
713
+ description: ''
714
+ headers: {}
715
+ content:
716
+ application/json:
717
+ schema:
718
+ type: object
719
+ deprecated: false
720
+ put:
721
+ tags:
722
+ - site
723
+ summary: updateSite
724
+ description: Updates and returns a site object containing information about an individual site (see <a href='https://kb.kentik.com/Cb13.htm#Cb13-About_Sites' target='_blank'>About Sites</a>).<br/>* Required fields.
725
+ operationId: updateSite
726
+ parameters:
727
+ - name: site_id
728
+ in: path
729
+ description: The id of the site whose information will be updated.
730
+ required: true
731
+ style: simple
732
+ schema:
733
+ type: integer
734
+ format: int32
735
+ requestBody:
736
+ description: ''
737
+ content:
738
+ application/json:
739
+ schema:
740
+ $ref: '#/components/schemas/updateSite'
741
+ required: true
742
+ responses:
743
+ '200':
744
+ description: ''
745
+ headers: {}
746
+ content:
747
+ application/json:
748
+ schema:
749
+ type: object
750
+ deprecated: false
751
+ delete:
752
+ tags:
753
+ - site
754
+ summary: deleteSite
755
+ description: Deletes a site.<br/>* Required fields.
756
+ operationId: deleteSite
757
+ parameters:
758
+ - name: site_id
759
+ in: path
760
+ description: The id of the site to delete.
761
+ required: true
762
+ style: simple
763
+ schema:
764
+ type: integer
765
+ format: int32
766
+ responses:
767
+ '200':
768
+ description: ''
769
+ headers: {}
770
+ content:
771
+ application/json:
772
+ schema:
773
+ type: object
774
+ deprecated: false
775
+ /site:
776
+ post:
777
+ tags:
778
+ - site
779
+ summary: createSite
780
+ description: Creates and returns a site object containing information about an individual site (see <a href='https://kb.kentik.com/Cb13.htm#Cb13-About_Sites' target='_blank'>About Sites</a>).<br/>* Required fields.
781
+ operationId: createSite
782
+ parameters: []
783
+ requestBody:
784
+ description: ''
785
+ content:
786
+ application/json:
787
+ schema:
788
+ $ref: '#/components/schemas/createSite'
789
+ required: true
790
+ responses:
791
+ '200':
792
+ description: ''
793
+ headers: {}
794
+ content:
795
+ application/json:
796
+ schema:
797
+ type: object
798
+ deprecated: false
799
+ /tags:
800
+ get:
801
+ tags:
802
+ - tag
803
+ summary: findTags
804
+ description: Returns an array of tag objects that each contain information about an individual tag (see <a href='https://kb.kentik.com/Eb02.htm#Eb02-About_Tags' target='_blank'>About Tags</a>).
805
+ operationId: findTags
806
+ parameters: []
807
+ responses:
808
+ '200':
809
+ description: ''
810
+ headers: {}
811
+ content:
812
+ application/json:
813
+ schema:
814
+ type: object
815
+ deprecated: false
816
+ /tag/{tag_id}:
817
+ get:
818
+ tags:
819
+ - tag
820
+ summary: findTag
821
+ description: Returns a tag object containing information about an individual tag (see <a href='https://kb.kentik.com/Eb02.htm#Eb02-About_Tags' target='_blank'>About Tags</a>).<br/>* Required fields.
822
+ operationId: findTag
823
+ parameters:
824
+ - name: tag_id
825
+ in: path
826
+ description: The id of the tag whose information will be returned.
827
+ required: true
828
+ style: simple
829
+ schema:
830
+ type: integer
831
+ format: int32
832
+ responses:
833
+ '200':
834
+ description: ''
835
+ headers: {}
836
+ content:
837
+ application/json:
838
+ schema:
839
+ type: object
840
+ deprecated: false
841
+ put:
842
+ tags:
843
+ - tag
844
+ summary: updateTag
845
+ description: Updates and returns a tag object containing information about an individual tag (see <a href='https://kb.kentik.com/Eb02.htm#Eb02-About_Tags' target='_blank'>About Tags</a>).<br/>* Required fields.
846
+ operationId: updateTag
847
+ parameters:
848
+ - name: tag_id
849
+ in: path
850
+ description: The id of the tag whose information will be updated.
851
+ required: true
852
+ style: simple
853
+ schema:
854
+ type: integer
855
+ format: int32
856
+ requestBody:
857
+ description: ''
858
+ content:
859
+ application/json:
860
+ schema:
861
+ $ref: '#/components/schemas/updateTag'
862
+ required: true
863
+ responses:
864
+ '200':
865
+ description: ''
866
+ headers: {}
867
+ content:
868
+ application/json:
869
+ schema:
870
+ type: object
871
+ deprecated: false
872
+ delete:
873
+ tags:
874
+ - tag
875
+ summary: deleteTag
876
+ description: Deletes a tag.<br/>* Required fields.
877
+ operationId: deleteTag
878
+ parameters:
879
+ - name: tag_id
880
+ in: path
881
+ description: The id of the tag to delete.
882
+ required: true
883
+ style: simple
884
+ schema:
885
+ type: integer
886
+ format: int32
887
+ responses:
888
+ '200':
889
+ description: ''
890
+ headers: {}
891
+ content:
892
+ application/json:
893
+ schema:
894
+ type: object
895
+ deprecated: false
896
+ /tag:
897
+ post:
898
+ tags:
899
+ - tag
900
+ summary: createTag
901
+ description: Creates and returns a tag object containing information about an individual tag (see <a href='https://kb.kentik.com/Eb02.htm#Eb02-About_Tags' target='_blank'>About Tags</a>).<br/>* Required fields.
902
+ operationId: createTag
903
+ parameters: []
904
+ requestBody:
905
+ description: ''
906
+ content:
907
+ application/json:
908
+ schema:
909
+ $ref: '#/components/schemas/createTag'
910
+ required: true
911
+ responses:
912
+ '200':
913
+ description: ''
914
+ headers: {}
915
+ content:
916
+ application/json:
917
+ schema:
918
+ type: object
919
+ deprecated: false
920
+ /customdimensions:
921
+ get:
922
+ tags:
923
+ - custom_dimension
924
+ summary: findCustomDimensions
925
+ description: Returns an array of custom dimension objects that each contain information about an individual custom dimension (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Custom Dimensions</a>).
926
+ operationId: findCustomDimensions
927
+ parameters: []
928
+ responses:
929
+ '200':
930
+ description: ''
931
+ headers: {}
932
+ content:
933
+ application/json:
934
+ schema:
935
+ type: object
936
+ deprecated: false
937
+ /customdimension/{dimension_id}:
938
+ get:
939
+ tags:
940
+ - custom_dimension
941
+ summary: findCustomDimension
942
+ description: Returns a custom dimension object containing information about an individual custom dimension (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Custom Dimensions</a>).<br/>* Required fields.
943
+ operationId: findCustomDimension
944
+ parameters:
945
+ - name: dimension_id
946
+ in: path
947
+ description: The id of the custom dimension whose information will be returned.
948
+ required: true
949
+ style: simple
950
+ schema:
951
+ type: integer
952
+ format: int32
953
+ responses:
954
+ '200':
955
+ description: ''
956
+ headers: {}
957
+ content:
958
+ application/json:
959
+ schema:
960
+ type: object
961
+ deprecated: false
962
+ put:
963
+ tags:
964
+ - custom_dimension
965
+ summary: updateCustomDimension
966
+ description: Updates and returns a custom dimension object containing information about an individual custom dimension (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Custom Dimensions</a>).<br/>* Required fields.<br/>Populators are not sent back in the response body. To get them use "Custom Dimension info" section instead.
967
+ operationId: updateCustomDimension
968
+ parameters:
969
+ - name: dimension_id
970
+ in: path
971
+ description: The id of the custom dimension whose information will be updated.
972
+ required: true
973
+ style: simple
974
+ schema:
975
+ type: integer
976
+ format: int32
977
+ requestBody:
978
+ description: ''
979
+ content:
980
+ application/json:
981
+ schema:
982
+ $ref: '#/components/schemas/updateCustomDimension'
983
+ required: true
984
+ responses:
985
+ '200':
986
+ description: ''
987
+ headers: {}
988
+ content:
989
+ application/json:
990
+ schema:
991
+ type: object
992
+ deprecated: false
993
+ delete:
994
+ tags:
995
+ - custom_dimension
996
+ summary: deleteCustomDimension
997
+ description: Deletes a custom dimension.<br/>* Required fields.
998
+ operationId: deleteCustomDimension
999
+ parameters:
1000
+ - name: dimension_id
1001
+ in: path
1002
+ description: The id of the custom dimension to delete.
1003
+ required: true
1004
+ style: simple
1005
+ schema:
1006
+ type: integer
1007
+ format: int32
1008
+ responses:
1009
+ '200':
1010
+ description: ''
1011
+ headers: {}
1012
+ content:
1013
+ application/json:
1014
+ schema:
1015
+ type: object
1016
+ deprecated: false
1017
+ /customdimension:
1018
+ post:
1019
+ tags:
1020
+ - custom_dimension
1021
+ summary: createCustomDimension
1022
+ description: Creates and returns a custom dimension object containing information about an individual custom dimension (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Custom Dimensions</a>).<br/>* Required fields.
1023
+ operationId: createCustomDimension
1024
+ parameters: []
1025
+ requestBody:
1026
+ description: ''
1027
+ content:
1028
+ application/json:
1029
+ schema:
1030
+ $ref: '#/components/schemas/createCustomDimension'
1031
+ required: true
1032
+ responses:
1033
+ '200':
1034
+ description: ''
1035
+ headers: {}
1036
+ content:
1037
+ application/json:
1038
+ schema:
1039
+ type: object
1040
+ deprecated: false
1041
+ /customdimension/{dimension_id}/populator/:
1042
+ post:
1043
+ tags:
1044
+ - custom_dimension
1045
+ summary: createPopulator
1046
+ description: Creates and returns a populator object containing information about an individual populator (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Populators</a>).<br/>* Required fields.
1047
+ operationId: createPopulator
1048
+ parameters:
1049
+ - name: dimension_id
1050
+ in: path
1051
+ description: The id of the custom dimension that contains the populator.
1052
+ required: true
1053
+ style: simple
1054
+ schema:
1055
+ type: integer
1056
+ format: int32
1057
+ requestBody:
1058
+ description: ''
1059
+ content:
1060
+ application/json:
1061
+ schema:
1062
+ $ref: '#/components/schemas/createPopulator'
1063
+ required: true
1064
+ responses:
1065
+ '200':
1066
+ description: ''
1067
+ headers: {}
1068
+ content:
1069
+ application/json:
1070
+ schema:
1071
+ type: object
1072
+ deprecated: false
1073
+ /customdimension/{dimension_id}/populator/{populator_id}:
1074
+ put:
1075
+ tags:
1076
+ - custom_dimension
1077
+ summary: updatePopulator
1078
+ description: Updates and returns a populator object containing information about an individual populator (see <a href='https://kb.kentik.com/proto/?Ec03.htm#Ec03-Custom_Dimension_API' target='_blank'>About Populators</a>).<br/>* Required fields.
1079
+ operationId: updatePopulator
1080
+ parameters:
1081
+ - name: populator_id
1082
+ in: path
1083
+ description: The id of the populator whose information will be updated.
1084
+ required: true
1085
+ style: simple
1086
+ schema:
1087
+ type: integer
1088
+ format: int32
1089
+ - name: dimension_id
1090
+ in: path
1091
+ description: The id of the custom dimension that contains the populator.
1092
+ required: true
1093
+ style: simple
1094
+ schema:
1095
+ type: integer
1096
+ format: int32
1097
+ requestBody:
1098
+ description: ''
1099
+ content:
1100
+ application/json:
1101
+ schema:
1102
+ $ref: '#/components/schemas/updatePopulator'
1103
+ required: true
1104
+ responses:
1105
+ '200':
1106
+ description: ''
1107
+ headers: {}
1108
+ content:
1109
+ application/json:
1110
+ schema:
1111
+ type: object
1112
+ deprecated: false
1113
+ delete:
1114
+ tags:
1115
+ - custom_dimension
1116
+ summary: deletePopulator
1117
+ description: Deletes a populator.<br/>* Required fields.
1118
+ operationId: deletePopulator
1119
+ parameters:
1120
+ - name: populator_id
1121
+ in: path
1122
+ description: The id of the populator to delete.
1123
+ required: true
1124
+ style: simple
1125
+ schema:
1126
+ type: integer
1127
+ format: int32
1128
+ - name: dimension_id
1129
+ in: path
1130
+ description: The id of the custom dimension that contains the populator to delete.
1131
+ required: true
1132
+ style: simple
1133
+ schema:
1134
+ type: integer
1135
+ format: int32
1136
+ responses:
1137
+ '200':
1138
+ description: ''
1139
+ headers: {}
1140
+ content:
1141
+ application/json:
1142
+ schema:
1143
+ type: object
1144
+ deprecated: false
1145
+ /customApplications:
1146
+ get:
1147
+ tags:
1148
+ - custom_application
1149
+ summary: findCustomApplications
1150
+ description: Returns an array of custom application object, each of which contains information about an individual custom application.<br/>* Required fields.
1151
+ operationId: findCustomApplications
1152
+ parameters: []
1153
+ responses:
1154
+ '200':
1155
+ description: ''
1156
+ headers: {}
1157
+ content:
1158
+ application/json:
1159
+ schema:
1160
+ type: object
1161
+ deprecated: false
1162
+ post:
1163
+ tags:
1164
+ - custom_application
1165
+ summary: createCustomApplication
1166
+ description: Creates and returns a custom application object containing information about an individual custom application.<br/>* Required fields.
1167
+ operationId: createCustomApplication
1168
+ parameters: []
1169
+ requestBody:
1170
+ description: ''
1171
+ content:
1172
+ application/json:
1173
+ schema:
1174
+ $ref: '#/components/schemas/createCustomApplication'
1175
+ required: true
1176
+ responses:
1177
+ '200':
1178
+ description: ''
1179
+ headers: {}
1180
+ content:
1181
+ application/json:
1182
+ schema:
1183
+ type: object
1184
+ deprecated: false
1185
+ /customApplications/{application_id}:
1186
+ put:
1187
+ tags:
1188
+ - custom_application
1189
+ summary: updateCustomApplication
1190
+ description: Updates and returns a custom application object containing information about an individual custom application.<br/>* Required fields.
1191
+ operationId: updateCustomApplication
1192
+ parameters:
1193
+ - name: application_id
1194
+ in: path
1195
+ description: The ID of the custom application whose information will be updated.
1196
+ required: true
1197
+ style: simple
1198
+ schema:
1199
+ type: integer
1200
+ format: int32
1201
+ requestBody:
1202
+ description: ''
1203
+ content:
1204
+ application/json:
1205
+ schema:
1206
+ $ref: '#/components/schemas/updateCustomApplication'
1207
+ required: true
1208
+ responses:
1209
+ '200':
1210
+ description: ''
1211
+ headers: {}
1212
+ content:
1213
+ application/json:
1214
+ schema:
1215
+ type: object
1216
+ deprecated: false
1217
+ delete:
1218
+ tags:
1219
+ - custom_application
1220
+ summary: deleteCustomApplication
1221
+ description: Deletes a custom application from the system.<br/>* Required fields.
1222
+ operationId: deleteCustomApplication
1223
+ parameters:
1224
+ - name: application_id
1225
+ in: path
1226
+ description: The id of the custom application to delete.
1227
+ required: true
1228
+ style: simple
1229
+ schema:
1230
+ type: integer
1231
+ format: int32
1232
+ responses:
1233
+ '200':
1234
+ description: ''
1235
+ headers: {}
1236
+ content:
1237
+ application/json:
1238
+ schema:
1239
+ type: object
1240
+ deprecated: false
1241
+ /saved-filters/custom:
1242
+ get:
1243
+ tags:
1244
+ - savedfilter
1245
+ summary: findSavedFilters
1246
+ description: Returns an array of saved filter objects, each of which contains information about an individual saved filter (see <a href='https://kb.kentik.com/Ec07.htm#Ec07-Saved_Filter_List' target='_blank'>Saved Filters</a>).<br/>* Required fields.
1247
+ operationId: findSavedFilters
1248
+ parameters: []
1249
+ responses:
1250
+ '200':
1251
+ description: ''
1252
+ headers: {}
1253
+ content:
1254
+ application/json:
1255
+ schema:
1256
+ type: object
1257
+ deprecated: false
1258
+ /saved-filter/custom/{savedfilter_id}:
1259
+ get:
1260
+ tags:
1261
+ - savedfilter
1262
+ summary: findSavedFilter
1263
+ description: Returns a saved filter object containing information about an individual saved filter (see <a href='https://kb.kentik.com/Ec07.htm#Ec07-Saved_Filter_Info' target='_blank'>Saved Filters</a>).<br/>* Required fields.
1264
+ operationId: findSavedFilter
1265
+ parameters:
1266
+ - name: savedfilter_id
1267
+ in: path
1268
+ description: The ID of the saved filter whose information will be returned.
1269
+ required: true
1270
+ style: simple
1271
+ schema:
1272
+ type: integer
1273
+ format: int32
1274
+ responses:
1275
+ '200':
1276
+ description: ''
1277
+ headers: {}
1278
+ content:
1279
+ application/json:
1280
+ schema:
1281
+ type: object
1282
+ deprecated: false
1283
+ put:
1284
+ tags:
1285
+ - savedfilter
1286
+ summary: updateSavedFilter
1287
+ description: Updates and returns a saved filter object containing information about an individual saved filter (see <a href='https://kb.kentik.com/Ec07.htm#Ec07-Saved_Filter_Update' target='_blank'>Saved Filters</a>).<br/>* Required fields.
1288
+ operationId: updateSavedFilter
1289
+ parameters:
1290
+ - name: savedfilter_id
1291
+ in: path
1292
+ description: The ID of the saved filter whose information will be updated.
1293
+ required: true
1294
+ style: simple
1295
+ schema:
1296
+ type: integer
1297
+ format: int32
1298
+ requestBody:
1299
+ description: ''
1300
+ content:
1301
+ application/json:
1302
+ schema:
1303
+ $ref: '#/components/schemas/updateSavedFilter'
1304
+ required: true
1305
+ responses:
1306
+ '200':
1307
+ description: ''
1308
+ headers: {}
1309
+ content:
1310
+ application/json:
1311
+ schema:
1312
+ type: object
1313
+ deprecated: false
1314
+ delete:
1315
+ tags:
1316
+ - savedfilter
1317
+ summary: deleteSavedFilter
1318
+ description: Deletes a saved filter from the system.<br/>* Required fields.
1319
+ operationId: deleteSavedFilter
1320
+ parameters:
1321
+ - name: savedfilter_id
1322
+ in: path
1323
+ description: The id of the saved filter to delete.
1324
+ required: true
1325
+ style: simple
1326
+ schema:
1327
+ type: integer
1328
+ format: int32
1329
+ responses:
1330
+ '200':
1331
+ description: ''
1332
+ headers: {}
1333
+ content:
1334
+ application/json:
1335
+ schema:
1336
+ type: object
1337
+ deprecated: false
1338
+ /saved-filter/custom:
1339
+ post:
1340
+ tags:
1341
+ - savedfilter
1342
+ summary: createSavedFilter
1343
+ description: Creates and returns a saved filter object containing information about an individual saved filter (see <a href='https://kb.kentik.com/Ec07.htm#Ec07-Saved_Filter_Create' target='_blank'>Saved Filters</a>).<br/>* Required fields.
1344
+ operationId: createSavedFilter
1345
+ parameters: []
1346
+ requestBody:
1347
+ description: ''
1348
+ content:
1349
+ application/json:
1350
+ schema:
1351
+ $ref: '#/components/schemas/createSavedFilter'
1352
+ required: true
1353
+ responses:
1354
+ '200':
1355
+ description: ''
1356
+ headers: {}
1357
+ content:
1358
+ application/json:
1359
+ schema:
1360
+ type: object
1361
+ deprecated: false
1362
+ /alerts/manual-mitigate:
1363
+ post:
1364
+ tags:
1365
+ - alerts
1366
+ summary: createManualMitigation
1367
+ description: Creates a manual mitigation. A mitigation started manually will not clear on its own. It must be stopped manually from the active alerts page.
1368
+ operationId: createManualMitigation
1369
+ parameters: []
1370
+ requestBody:
1371
+ description: ''
1372
+ content:
1373
+ application/json:
1374
+ schema:
1375
+ $ref: '#/components/schemas/createManualMitigation'
1376
+ required: true
1377
+ responses:
1378
+ '200':
1379
+ description: ''
1380
+ headers: {}
1381
+ content:
1382
+ application/json:
1383
+ schema:
1384
+ type: object
1385
+ deprecated: false
1386
+ /alerts-active/alarms:
1387
+ get:
1388
+ tags:
1389
+ - alerts_active
1390
+ summary: alarms
1391
+ description: Returns alarms.
1392
+ operationId: alarms
1393
+ parameters:
1394
+ - name: startTime
1395
+ in: query
1396
+ description: startTime - The startTime of the alert. E.g. "2018-10-15T22:15:00".
1397
+ required: true
1398
+ style: form
1399
+ explode: true
1400
+ schema:
1401
+ type: string
1402
+ - name: endTime
1403
+ in: query
1404
+ description: endTime - The endTime of the alert. E.g. "2018-10-15T22:16:00".
1405
+ required: true
1406
+ style: form
1407
+ explode: true
1408
+ schema:
1409
+ type: string
1410
+ - name: filterBy
1411
+ in: query
1412
+ description: 'filterBy - The filter by field. (Acceptable values are: "", "old_state", "new_state", "any_state", "alert_key_partial", "dimension_key", "mitigation_id", "alert_id", "alert_key", "alarm_id")'
1413
+ required: true
1414
+ style: form
1415
+ explode: true
1416
+ schema:
1417
+ type: string
1418
+ - name: filterVal
1419
+ in: query
1420
+ description: filterVal - The filter by value.
1421
+ required: true
1422
+ style: form
1423
+ explode: true
1424
+ schema:
1425
+ type: string
1426
+ - name: showMitigations
1427
+ in: query
1428
+ description: showMitigations - 0 showMitigations off, 1 showMitigations on.
1429
+ required: true
1430
+ style: form
1431
+ explode: true
1432
+ schema:
1433
+ type: integer
1434
+ format: int32
1435
+ - name: showAlarms
1436
+ in: query
1437
+ description: showAlarms - 0 showAlarms off, 1 showAlarms on.
1438
+ required: true
1439
+ style: form
1440
+ explode: true
1441
+ schema:
1442
+ type: integer
1443
+ format: int32
1444
+ - name: showMatches
1445
+ in: query
1446
+ description: showMatches - 0 showMatches off, 1 showMatches on.
1447
+ required: true
1448
+ style: form
1449
+ explode: true
1450
+ schema:
1451
+ type: integer
1452
+ format: int32
1453
+ - name: learningMode
1454
+ in: query
1455
+ description: learningMode - 0 learning mode off, 1 learning mode on.
1456
+ required: true
1457
+ style: form
1458
+ explode: true
1459
+ schema:
1460
+ type: integer
1461
+ format: int32
1462
+ responses:
1463
+ '200':
1464
+ description: ''
1465
+ headers: {}
1466
+ content:
1467
+ application/json:
1468
+ schema:
1469
+ type: object
1470
+ deprecated: false
1471
+ /alerts-active/alerts-history:
1472
+ get:
1473
+ tags:
1474
+ - alerts_active
1475
+ summary: alertsHistory
1476
+ description: Returns alerts history.
1477
+ operationId: alertsHistory
1478
+ parameters:
1479
+ - name: startTime
1480
+ in: query
1481
+ description: startTime - The startTime of the alert. E.g. "2018-10-15T22:15:00".
1482
+ required: true
1483
+ style: form
1484
+ explode: true
1485
+ schema:
1486
+ type: string
1487
+ - name: endTime
1488
+ in: query
1489
+ description: endTime - The endTime of the alert. E.g. "2018-10-15T22:16:00".
1490
+ required: true
1491
+ style: form
1492
+ explode: true
1493
+ schema:
1494
+ type: string
1495
+ - name: filterBy
1496
+ in: query
1497
+ description: 'filterBy - The filter by field. (Acceptable values are: "", "old_state", "new_state", "any_state", "alert_key_partial", "dimension_key", "mitigation_id", "alert_id", "alert_key", "alarm_id")'
1498
+ required: true
1499
+ style: form
1500
+ explode: true
1501
+ schema:
1502
+ type: string
1503
+ - name: filterVal
1504
+ in: query
1505
+ description: filterVal - The filter by value.
1506
+ required: true
1507
+ style: form
1508
+ explode: true
1509
+ schema:
1510
+ type: string
1511
+ - name: sortOrder
1512
+ in: query
1513
+ description: 'sortOrder - The dimension to sort by. (Acceptable values are: "alert_key", "severity", "mitigation_id", "alarm_id", "alert_id", "alert_value", "alarm_state")'
1514
+ required: true
1515
+ style: form
1516
+ explode: true
1517
+ schema:
1518
+ type: string
1519
+ - name: showMitigations
1520
+ in: query
1521
+ description: showMitigations - 0 showMitigations off, 1 showMitigations on.
1522
+ required: true
1523
+ style: form
1524
+ explode: true
1525
+ schema:
1526
+ type: integer
1527
+ format: int32
1528
+ - name: showAlarms
1529
+ in: query
1530
+ description: showAlarms - 0 showAlarms off, 1 showAlarms on.
1531
+ required: true
1532
+ style: form
1533
+ explode: true
1534
+ schema:
1535
+ type: integer
1536
+ format: int32
1537
+ - name: showMatches
1538
+ in: query
1539
+ description: showMatches - 0 showMatches off, 1 showMatches on.
1540
+ required: true
1541
+ style: form
1542
+ explode: true
1543
+ schema:
1544
+ type: integer
1545
+ format: int32
1546
+ - name: learningMode
1547
+ in: query
1548
+ description: learningMode - 0 learning mode off, 1 learning mode on.
1549
+ required: true
1550
+ style: form
1551
+ explode: true
1552
+ schema:
1553
+ type: integer
1554
+ format: int32
1555
+ responses:
1556
+ '200':
1557
+ description: ''
1558
+ headers: {}
1559
+ content:
1560
+ application/json:
1561
+ schema:
1562
+ type: object
1563
+ deprecated: false
1564
+ /mykentik/tenants:
1565
+ get:
1566
+ tags:
1567
+ - My Kentik Portal
1568
+ summary: findUserGroups
1569
+ description: Returns an array of tenants, each of which contains information about an individual tenant (see <a href='https://kb.kentik.com/Cb15.htm#Cb15-Tenant_List' target='_blank'>Tenant List</a>).<br/>* Required fields.
1570
+ operationId: findUserGroups
1571
+ parameters: []
1572
+ responses:
1573
+ '200':
1574
+ description: ''
1575
+ headers: {}
1576
+ content:
1577
+ application/json:
1578
+ schema:
1579
+ type: object
1580
+ deprecated: false
1581
+ /mykentik/tenant/{tenant_id}:
1582
+ get:
1583
+ tags:
1584
+ - My Kentik Portal
1585
+ summary: findUserGroup
1586
+ description: Returns a tenant object containing information about an individual tenant (see <a href='https://kb.kentik.com/Cb15.htm#Cb15-Tenant_Dialogs' target='_blank'>Tenant Dialogs</a>).<br/>* Required fields.
1587
+ operationId: findUserGroup
1588
+ parameters:
1589
+ - name: tenant_id
1590
+ in: path
1591
+ description: tenant_id - The ID of the tenant whose information will be returned.
1592
+ required: true
1593
+ style: simple
1594
+ schema:
1595
+ type: integer
1596
+ format: int32
1597
+ responses:
1598
+ '200':
1599
+ description: ''
1600
+ headers: {}
1601
+ content:
1602
+ application/json:
1603
+ schema:
1604
+ type: object
1605
+ deprecated: false
1606
+ /mykentik/tenant/{tenant_id}/user:
1607
+ post:
1608
+ tags:
1609
+ - My Kentik Portal
1610
+ summary: createTenantUser
1611
+ description: Creates and returns a tenant user object containing information about an individual tenant user (see <a href='https://kb.kentik.com/Cb15.htm#Cb15-Add_a_Tenant_User' target='_blank'>Add a Tenant User</a>).<br/>* Required fields.
1612
+ operationId: createTenantUser
1613
+ parameters:
1614
+ - name: tenant_id
1615
+ in: path
1616
+ description: tenant_id - The ID of the tenant.
1617
+ required: true
1618
+ style: simple
1619
+ schema:
1620
+ type: integer
1621
+ format: int32
1622
+ requestBody:
1623
+ description: ''
1624
+ content:
1625
+ application/json:
1626
+ schema:
1627
+ $ref: '#/components/schemas/createTenantUser'
1628
+ required: true
1629
+ responses:
1630
+ '200':
1631
+ description: ''
1632
+ headers: {}
1633
+ content:
1634
+ application/json:
1635
+ schema:
1636
+ type: object
1637
+ deprecated: false
1638
+ /mykentik/tenant/{tenant_id}/user/{user_id}:
1639
+ delete:
1640
+ tags:
1641
+ - My Kentik Portal
1642
+ summary: deleteTenantUser
1643
+ description: Deletes a tenant user from the system (see <a href='https://kb.kentik.com/Cb15.htm#Cb15-Remove_a_Tenant_User' target='_blank'>Remove a Tenant User</a>).<br/>* Required fields.
1644
+ operationId: deleteTenantUser
1645
+ parameters:
1646
+ - name: tenant_id
1647
+ in: path
1648
+ description: tenant_id - The ID of the tenant.
1649
+ required: true
1650
+ style: simple
1651
+ schema:
1652
+ type: integer
1653
+ format: int32
1654
+ - name: user_id
1655
+ in: path
1656
+ description: user_id - The ID of the user.
1657
+ required: true
1658
+ style: simple
1659
+ schema:
1660
+ type: integer
1661
+ format: int32
1662
+ responses:
1663
+ '200':
1664
+ description: ''
1665
+ headers: {}
1666
+ content:
1667
+ application/json:
1668
+ schema:
1669
+ type: object
1670
+ deprecated: false
1671
+ components:
1672
+ schemas:
1673
+ runQuery:
1674
+ title: runQuery
1675
+ type: object
1676
+ properties:
1677
+ query:
1678
+ type: string
1679
+ description: SQL query to run.
1680
+ queryUrl:
1681
+ title: queryUrl
1682
+ type: object
1683
+ properties:
1684
+ version:
1685
+ $ref: '#/components/schemas/KentikPortalVersion'
1686
+ queries:
1687
+ type: array
1688
+ items:
1689
+ $ref: '#/components/schemas/query'
1690
+ description: ''
1691
+ topxdata:
1692
+ title: topxdata
1693
+ type: object
1694
+ properties:
1695
+ queries:
1696
+ type: array
1697
+ items:
1698
+ $ref: '#/components/schemas/query2'
1699
+ description: ''
1700
+ topxchart:
1701
+ title: topxchart
1702
+ type: object
1703
+ properties:
1704
+ queries:
1705
+ type: array
1706
+ items:
1707
+ $ref: '#/components/schemas/query4'
1708
+ description: ''
1709
+ imageType:
1710
+ $ref: '#/components/schemas/imageType'
1711
+ createUser:
1712
+ title: createUser
1713
+ type: object
1714
+ properties:
1715
+ user:
1716
+ $ref: '#/components/schemas/User'
1717
+ updateUser:
1718
+ title: updateUser
1719
+ type: object
1720
+ properties:
1721
+ user:
1722
+ $ref: '#/components/schemas/User1'
1723
+ createDevice:
1724
+ title: createDevice
1725
+ type: object
1726
+ properties:
1727
+ device:
1728
+ $ref: '#/components/schemas/Device'
1729
+ updateDevice:
1730
+ title: updateDevice
1731
+ type: object
1732
+ properties:
1733
+ device:
1734
+ $ref: '#/components/schemas/Device1'
1735
+ deviceApplyLabels:
1736
+ title: deviceApplyLabels
1737
+ required:
1738
+ - labels
1739
+ type: object
1740
+ properties:
1741
+ labels:
1742
+ type: array
1743
+ items:
1744
+ $ref: '#/components/schemas/Labelid'
1745
+ description: ''
1746
+ createDeviceLabel:
1747
+ title: createDeviceLabel
1748
+ required:
1749
+ - name
1750
+ - color
1751
+ type: object
1752
+ properties:
1753
+ name:
1754
+ type: string
1755
+ description: name - The name of the device label.
1756
+ color:
1757
+ type: string
1758
+ description: color - The color of device label.
1759
+ updateDeviceLabel:
1760
+ title: updateDeviceLabel
1761
+ required:
1762
+ - name
1763
+ type: object
1764
+ properties:
1765
+ name:
1766
+ type: string
1767
+ description: name - The name of the device label.
1768
+ color:
1769
+ type: string
1770
+ description: color - The color of device label.
1771
+ createInterface:
1772
+ title: createInterface
1773
+ required:
1774
+ - snmp_id
1775
+ - interface_description
1776
+ - snmp_speed
1777
+ type: object
1778
+ properties:
1779
+ snmp_id:
1780
+ type: string
1781
+ description: snmp_id - The SNMP ID of the interface.
1782
+ interface_description:
1783
+ type: string
1784
+ description: interface_description - The name of the interface.
1785
+ snmp_alias:
1786
+ type: string
1787
+ description: snmp_alias - The description of the interface.
1788
+ interface_ip:
1789
+ type: string
1790
+ description: interface_ip - The IP address assigned to the interface.
1791
+ interface_ip_netmask:
1792
+ type: string
1793
+ description: interface_ip_netmask - Netmask for the interface.
1794
+ snmp_speed:
1795
+ type: number
1796
+ description: snmp_speed - The capacity of the interface in Mbps.
1797
+ secondary_ips:
1798
+ type: array
1799
+ items:
1800
+ $ref: '#/components/schemas/SecondaryIP'
1801
+ description: ''
1802
+ vrf:
1803
+ $ref: '#/components/schemas/VRF'
1804
+ updateInterface:
1805
+ title: updateInterface
1806
+ required:
1807
+ - snmp_id
1808
+ - snmp_speed
1809
+ type: object
1810
+ properties:
1811
+ snmp_id:
1812
+ type: number
1813
+ description: snmp_id - The SNMP ID of the interface.
1814
+ interface_description:
1815
+ type: string
1816
+ description: interface_description - The name of the interface.
1817
+ snmp_alias:
1818
+ type: string
1819
+ description: snmp_alias - The description of the interface.
1820
+ interface_ip:
1821
+ type: string
1822
+ description: interface_ip - The IP address assigned to the interface.
1823
+ interface_ip_netmask:
1824
+ type: string
1825
+ description: interface_ip_netmask - Netmask for the interface.
1826
+ snmp_speed:
1827
+ type: number
1828
+ description: snmp_speed - The capacity of the interface in Mbps.
1829
+ secondary_ips:
1830
+ type: array
1831
+ items:
1832
+ $ref: '#/components/schemas/SecondaryIP'
1833
+ description: ''
1834
+ vrf:
1835
+ $ref: '#/components/schemas/VRF'
1836
+ createSite:
1837
+ title: createSite
1838
+ type: object
1839
+ properties:
1840
+ site:
1841
+ $ref: '#/components/schemas/Site'
1842
+ updateSite:
1843
+ title: updateSite
1844
+ type: object
1845
+ properties:
1846
+ site:
1847
+ $ref: '#/components/schemas/Site1'
1848
+ createTag:
1849
+ title: createTag
1850
+ type: object
1851
+ properties:
1852
+ tag:
1853
+ $ref: '#/components/schemas/Tag'
1854
+ updateTag:
1855
+ title: updateTag
1856
+ type: object
1857
+ properties:
1858
+ tag:
1859
+ $ref: '#/components/schemas/Tag'
1860
+ createCustomDimension:
1861
+ title: createCustomDimension
1862
+ required:
1863
+ - name
1864
+ - type
1865
+ - display_name
1866
+ type: object
1867
+ properties:
1868
+ name:
1869
+ type: string
1870
+ description: 'name - The name of the custom dimension. Must start with "c_". Valid characters: alphanumeric dashes and underscores. Length: min=1, max=20.'
1871
+ type:
1872
+ $ref: '#/components/schemas/Type'
1873
+ display_name:
1874
+ type: string
1875
+ description: 'display_name - The name to be displayed of the custom dimension. Valid characters: alphanumeric spaces, dashes and underscores. Length: min=2, max=30.'
1876
+ updateCustomDimension:
1877
+ title: updateCustomDimension
1878
+ type: object
1879
+ properties:
1880
+ display_name:
1881
+ type: string
1882
+ description: 'display_name - The name to be displayed of the custom dimension. Valid characters: alphanumeric spaces, dashes and underscores. Length: min=2, max=30.'
1883
+ createPopulator:
1884
+ title: createPopulator
1885
+ type: object
1886
+ properties:
1887
+ populator:
1888
+ $ref: '#/components/schemas/Populator'
1889
+ updatePopulator:
1890
+ title: updatePopulator
1891
+ type: object
1892
+ properties:
1893
+ populator:
1894
+ $ref: '#/components/schemas/Populator'
1895
+ createCustomApplication:
1896
+ title: createCustomApplication
1897
+ required:
1898
+ - name
1899
+ type: object
1900
+ properties:
1901
+ name:
1902
+ type: string
1903
+ description: name - A unique name for the custom application.
1904
+ description:
1905
+ type: string
1906
+ description: description - An optional description for the custom application.
1907
+ ip_range:
1908
+ type: string
1909
+ description: ip_range - A comma-separated list of IP addresses in IP/CIDR format.
1910
+ protocol:
1911
+ type: string
1912
+ description: protocol - A comma-separated list of protocol numbers.
1913
+ port:
1914
+ type: string
1915
+ description: port - A comma-separated list of port numbers.
1916
+ asn:
1917
+ type: string
1918
+ description: asn - A comma-separated list of ASNs.
1919
+ updateCustomApplication:
1920
+ title: updateCustomApplication
1921
+ type: object
1922
+ properties:
1923
+ name:
1924
+ type: string
1925
+ description: name - A unique name for the custom application.
1926
+ description:
1927
+ type: string
1928
+ description: description - An optional description for the custom application.
1929
+ ip_range:
1930
+ type: string
1931
+ description: ip_range - A comma-separated list of IP addresses in IP/CIDR format.
1932
+ protocol:
1933
+ type: string
1934
+ description: protocol - A comma-separated list of protocol numbers.
1935
+ port:
1936
+ type: string
1937
+ description: port - A comma-separated list of port numbers.
1938
+ asn:
1939
+ type: string
1940
+ description: asn - A comma-separated list of ASNs.
1941
+ createSavedFilter:
1942
+ title: createSavedFilter
1943
+ required:
1944
+ - filter_name
1945
+ type: object
1946
+ properties:
1947
+ filter_name:
1948
+ type: string
1949
+ description: filter_name - An unique name for the saved filter.
1950
+ filter_description:
1951
+ type: string
1952
+ description: filter_description - The saved filter's description.
1953
+ filters:
1954
+ $ref: '#/components/schemas/Filters1'
1955
+ updateSavedFilter:
1956
+ title: updateSavedFilter
1957
+ type: object
1958
+ properties:
1959
+ filter_name:
1960
+ type: string
1961
+ description: filter_name - An unique name for the saved filter.
1962
+ filter_description:
1963
+ type: string
1964
+ description: filter_description - The saved filter's description.
1965
+ filters:
1966
+ $ref: '#/components/schemas/Filters1'
1967
+ createManualMitigation:
1968
+ title: createManualMitigation
1969
+ required:
1970
+ - ipCidr
1971
+ - platformID
1972
+ - methodID
1973
+ type: object
1974
+ properties:
1975
+ ipCidr:
1976
+ type: string
1977
+ description: ipCidr - IP/CIDR To Mitigate
1978
+ comment:
1979
+ type: string
1980
+ description: comment - Comment
1981
+ platformID:
1982
+ type: string
1983
+ description: platformID - Platform id.
1984
+ methodID:
1985
+ type: string
1986
+ description: methodID - Method id.
1987
+ minutesBeforeAutoStop:
1988
+ type: number
1989
+ description: minutesBeforeAutoStop - Minutes Before Auto Stop.
1990
+ default: 0
1991
+ createTenantUser:
1992
+ title: createTenantUser
1993
+ type: object
1994
+ properties:
1995
+ user:
1996
+ $ref: '#/components/schemas/User2'
1997
+ aggregate:
1998
+ title: aggregate
1999
+ type: object
2000
+ properties:
2001
+ name:
2002
+ type: string
2003
+ description: name - Name of the aggregate you're defining.
2004
+ column:
2005
+ $ref: '#/components/schemas/column'
2006
+ fn:
2007
+ $ref: '#/components/schemas/fn'
2008
+ rank:
2009
+ type: number
2010
+ description: rank - Digit 5 to 99, for use with 'percentile' fn
2011
+ leftOperand:
2012
+ type: string
2013
+ description: leftOperand - Value for left side of composite equation; used only for 'composite' fn
2014
+ compositeFn:
2015
+ $ref: '#/components/schemas/compositeFn'
2016
+ rightOperand:
2017
+ $ref: '#/components/schemas/rightOperand'
2018
+ raw:
2019
+ type: boolean
2020
+ description: raw - Whether or not to send raw 'chart' data back from the 'column' configured. required for topxchart calls.
2021
+ default: false
2022
+ AuthenticationProtocol:
2023
+ title: AuthenticationProtocol
2024
+ enum:
2025
+ - NoAuth
2026
+ - MD5
2027
+ - SHA
2028
+ type: string
2029
+ description: AuthenticationProtocol - the auth protocol to use via SNMP v3
2030
+ BGPType:
2031
+ title: BGPType
2032
+ enum:
2033
+ - none
2034
+ - device
2035
+ - other_device
2036
+ type: string
2037
+ description: 'device_bgp_type - Device bgp type. Valid values: "none" (use generic IP/ASN mapping), "device" (peer with the device itself), "other_device" (share routing table of existing peered device)'
2038
+ BGP:
2039
+ title: BGP
2040
+ enum:
2041
+ - none
2042
+ - device
2043
+ - other_device
2044
+ type: string
2045
+ description: 'device_bgp_type - Device bgp type. Valid values: "none" (use generic IP/ASN mapping), "device" (peer with the device itself), "other_device" (share routing table of existing peered device)'
2046
+ column:
2047
+ title: column
2048
+ enum:
2049
+ - f_sum_both_bytes
2050
+ - f_sum_in_bytes
2051
+ - f_sum_out_bytes
2052
+ - f_sum_both_pkts
2053
+ - f_sum_in_pkts
2054
+ - f_sum_out_pkts
2055
+ - f_sum_tcp_retransmit
2056
+ - perc_retransmits
2057
+ - f_sum_retransmitted_in_pkts
2058
+ - perc_retransmits_in
2059
+ - f_sum_ooorder_in_pkts
2060
+ - perc_ooorder_in
2061
+ - f_sum_fragments
2062
+ - perc_fragments
2063
+ - f_sum_client_nw_latency_ms
2064
+ - trautocount
2065
+ - f_sum_server_nw_latency_ms
2066
+ - f_sum_appl_latency_ms
2067
+ - f_countdistinct_ipv4_src_addr
2068
+ - f_countdistinct_ipv4_dst_addr
2069
+ type: string
2070
+ description: column - The raw SQL column to use as the source for this aggregation.
2071
+ compositeFn:
2072
+ title: compositeFn
2073
+ enum:
2074
+ - sum
2075
+ - subtract
2076
+ - multiply
2077
+ - divide
2078
+ type: string
2079
+ description: compositeFn - Operator function.
2080
+ connector:
2081
+ title: connector
2082
+ enum:
2083
+ - All
2084
+ - Any
2085
+ type: string
2086
+ description: connector - An AND/OR switch.
2087
+ ContributeToCDNAttribution:
2088
+ title: ContributeToCDNAttribution
2089
+ enum:
2090
+ - Y
2091
+ - N
2092
+ type: string
2093
+ description: "cdn_attr - If this is a DNS server, you can contribute its queries to Kentik's CDN attribution database. Valid values: \"Y\" or \"N\". ** cdn_attr is required when the device subtype's parent type is \"host-nprobe-dns-www\""
2094
+ ContributeToCDNAttribution1:
2095
+ title: ContributeToCDNAttribution1
2096
+ enum:
2097
+ - Y
2098
+ - N
2099
+ type: string
2100
+ description: "cdn_attr - If this is a DNS server, you can contribute its queries to Kentik's CDN attribution database. Valid values: \"Y\" or \"N\". cdn_attr is ignored when the device subtype's parent type is not \"host-nprobe-dns-www\"."
2101
+ Device:
2102
+ title: Device
2103
+ required:
2104
+ - device_name
2105
+ - device_subtype
2106
+ - plan_id
2107
+ - device_bgp_type
2108
+ type: object
2109
+ properties:
2110
+ device_name:
2111
+ type: string
2112
+ description: 'device_name - The name of the device. Valid characters: alphanumeric and underscores. Length: min=4, max=60.'
2113
+ device_subtype:
2114
+ $ref: '#/components/schemas/Devicesubtype'
2115
+ cdn_attr:
2116
+ $ref: '#/components/schemas/ContributeToCDNAttribution'
2117
+ device_description:
2118
+ type: string
2119
+ description: 'device_description - The device description. Valid characters: any. Length: max=128.'
2120
+ sending_ips:
2121
+ type: array
2122
+ items:
2123
+ type: string
2124
+ description: ''
2125
+ default: []
2126
+ device_sample_rate:
2127
+ type: number
2128
+ description: "device_sample_rate - The rate at which the device is sampling flows. Valid values: integer bigger than 1. Recommended rate varies depending on flow volume; see https://kb.kentik.com/Ab02.htm#Ab02-Flow_Sampling. ** device_sample_rate is required when the device subtype's parent type is \"router\"."
2129
+ plan_id:
2130
+ type: number
2131
+ description: 'plan_id - The ID of the plan to which this device is assigned. Available plan(s) can be found via the Plans API. Valid value: integer.'
2132
+ site_id:
2133
+ type: number
2134
+ description: 'site_id - The ID of the site (if any) to which this device is assigned. Site IDs are system generated when a site is created. Valid value: integer.'
2135
+ minimize_snmp:
2136
+ type: boolean
2137
+ description: minimize_snmp - The interval at which SNMP will be polled. If "false" (Standard), interface counter will be polled every 10 minutes and interface description every 30 minutes. If "true" (Minimum) (Minimum), interface counter won't be polled and interface description will be polled every 6 hours. ** minimize_snmp is required when the device subtype's parent type is "router".
2138
+ default: false
2139
+ device_snmp_ip:
2140
+ type: string
2141
+ description: device_snmp_ip - The SNMP IP to use when polling the device. device_snmp_ip is ignored unless the device subtype's parent type is "router".
2142
+ device_snmp_community:
2143
+ type: string
2144
+ description: device_snmp_community - The SNMP community to use when polling the device. device_snmp_community is ignored unless the device subtype's parent type is "router".
2145
+ device_snmp_v3_conf:
2146
+ $ref: '#/components/schemas/DeviceSnmpV3Conf'
2147
+ device_bgp_type:
2148
+ $ref: '#/components/schemas/BGPType'
2149
+ device_bgp_neighbor_ip:
2150
+ type: string
2151
+ description: device_bgp_neighbor_ip - A valid IPv4 address to use for peering with the device. ** An IPv4 and/or IPv6 peering address is required when device_bgp_type is set to "device".
2152
+ device_bgp_neighbor_ip6:
2153
+ type: string
2154
+ description: device_bgp_neighbor_ip6 - A valid IPv6 address to use for peering with the device. ** An IPv4 and/or IPv6 peering address is required when device_bgp_type is set to "device".
2155
+ device_bgp_neighbor_asn:
2156
+ type: string
2157
+ description: device_bgp_neighbor_asn - The valid AS number (ASN) of the autonomous system that this device belongs to. ** device_bgp_neighbor_asn is required when device_bgp_type is set to "device".
2158
+ device_bgp_password:
2159
+ type: string
2160
+ description: 'device_bgp_password - Optional BGP MD5 password (shared authentication password for BGP peering). Valid characters: alphanumeric. Length: 32. device_bgp_password is optional when device_bgp_type is set to "device".'
2161
+ use_bgp_device_id:
2162
+ type: number
2163
+ description: 'use_bgp_device_id - The ID of the device whose BGP table should be shared with this device. ** use_bgp_device_id is required when device_bgp_type is set to "other_device"). Valid value: a system-generated device_id.'
2164
+ device_bgp_flowspec:
2165
+ type: boolean
2166
+ description: device_bgp_flowspec - Toggle BGP Flowspec Compatibility for device.
2167
+ default: false
2168
+ Devicesubtype:
2169
+ title: Devicesubtype
2170
+ enum:
2171
+ - router
2172
+ - host-nprobe-dns-www
2173
+ - aws-subnet
2174
+ - azure_subnet
2175
+ - cisco_asa
2176
+ - gcp-subnet
2177
+ - istio_beta
2178
+ - open_nms
2179
+ - paloalto
2180
+ - silverpeak
2181
+ type: string
2182
+ description: device_subtype - The device subtype.
2183
+ Device1:
2184
+ title: Device1
2185
+ required:
2186
+ - device_sample_rate
2187
+ - device_bgp_type
2188
+ type: object
2189
+ properties:
2190
+ cdn_attr:
2191
+ $ref: '#/components/schemas/ContributeToCDNAttribution1'
2192
+ device_description:
2193
+ type: string
2194
+ description: 'device_description - The device description. Valid characters: any. Length: max=128.'
2195
+ sending_ips:
2196
+ type: array
2197
+ items:
2198
+ type: string
2199
+ description: ''
2200
+ device_sample_rate:
2201
+ type: number
2202
+ description: "device_sample_rate - The rate at which the device is sampling flows. Valid values: integer bigger than 1. Recommended rate varies depending on flow volume; see https://kb.kentik.com/Ab02.htm#Ab02-Flow_Sampling. device_sample_rate is ignored unless the device subtype's parent type is \"router\"."
2203
+ plan_id:
2204
+ type: number
2205
+ description: 'plan_id - The ID of the plan to which this device is assigned. Available plan(s) can be found via the Plans API. Valid value: integer.'
2206
+ site_id:
2207
+ type: number
2208
+ description: 'site_id - The ID of the site (if any) to which this device is assigned. Site IDs are system generated when a site is created. Valid value: integer.'
2209
+ minimize_snmp:
2210
+ type: boolean
2211
+ description: minimize_snmp - The interval at which SNMP will be polled. If "false" (Standard), interface counter will be polled every 10 minutes and interface description every 30 minutes. If "true" (Minimum) (Minimum), interface counter won't be polled and interface description will be polled every 6 hours. minimize_snmp is ignored unless parent type is "router".
2212
+ device_snmp_ip:
2213
+ type: string
2214
+ description: device_snmp_ip - The SNMP IP to use when polling the device. device_snmp_ip is ignored unless parent type is "router".
2215
+ device_snmp_community:
2216
+ type: string
2217
+ description: device_snmp_community - The SNMP community to use when polling the device. device_snmp_community is ignored unless parent type is "router".
2218
+ device_snmp_v3_conf:
2219
+ $ref: '#/components/schemas/DeviceSnmpV3Conf1'
2220
+ device_bgp_type:
2221
+ $ref: '#/components/schemas/BGPType'
2222
+ device_bgp_neighbor_ip:
2223
+ type: string
2224
+ description: device_bgp_neighbor_ip - A valid IPv4 address to use for peering with the device. device_bgp_neighbor_ip is ignored unless device_bgp_type is set to "device".
2225
+ device_bgp_neighbor_ip6:
2226
+ type: string
2227
+ description: device_bgp_neighbor_ip6 - A valid IPv6 address to use for peering with the device. device_bgp_neighbor_ip6 is ignored unless device_bgp_type is set to "device".
2228
+ device_bgp_neighbor_asn:
2229
+ type: string
2230
+ description: device_bgp_neighbor_asn - The valid AS number (ASN) of the autonomous system that this device belongs to. device_bgp_neighbor_asn is ignored unless device_bgp_type is set to "device".
2231
+ device_bgp_password:
2232
+ type: string
2233
+ description: 'device_bgp_password - Optional BGP MD5 password (shared authentication password for BGP peering). Valid characters: alphanumeric. Length: 32. device_bgp_password is ignored unless device_bgp_type is set to "device".'
2234
+ use_bgp_device_id:
2235
+ type: number
2236
+ description: 'use_bgp_device_id - The ID of the device whose BGP table should be shared with this device. ** use_bgp_device_id is required when device_bgp_type is set to "other_device"). Valid value: a system-generated device_id.'
2237
+ device_bgp_flowspec:
2238
+ type: boolean
2239
+ description: device_bgp_flowspec - Toggle BGP Flowspec Compatibility for device.
2240
+ default: false
2241
+ dimension:
2242
+ title: dimension
2243
+ enum:
2244
+ - AS_src
2245
+ - Geography_src
2246
+ - InterfaceID_src
2247
+ - Port_src
2248
+ - src_eth_mac
2249
+ - VLAN_src
2250
+ - IP_src
2251
+ - AS_dst
2252
+ - Geography_dst
2253
+ - InterfaceID_dst
2254
+ - Port_dst
2255
+ - dst_eth_mac
2256
+ - VLAN_dst
2257
+ - IP_dst
2258
+ - TopFlow
2259
+ - Proto
2260
+ - Traffic
2261
+ - ASTopTalkers
2262
+ - InterfaceTopTalkers
2263
+ - PortPortTalkers
2264
+ - TopFlowsIP
2265
+ - src_geo_region
2266
+ - src_geo_city
2267
+ - dst_geo_region
2268
+ - dst_geo_city
2269
+ - RegionTopTalkers
2270
+ - i_device_id
2271
+ - i_device_site_name
2272
+ - src_route_prefix_len
2273
+ - src_route_length
2274
+ - src_bgp_community
2275
+ - src_bgp_aspath
2276
+ - src_nexthop_ip
2277
+ - src_nexthop_asn
2278
+ - src_second_asn
2279
+ - src_third_asn
2280
+ - src_proto_port
2281
+ - dst_route_prefix_len
2282
+ - dst_route_length
2283
+ - dst_bgp_community
2284
+ - dst_bgp_aspath
2285
+ - dst_nexthop_ip
2286
+ - dst_nexthop_asn
2287
+ - dst_second_asn
2288
+ - dst_third_asn
2289
+ - dst_proto_port
2290
+ - inet_family
2291
+ - TOS
2292
+ - tcp_flags
2293
+ type: string
2294
+ description: 'dimension - A field by which to aggregate results. (NOTE: you may also use a custom dimension name here -- but not available in this tester).'
2295
+ Direction:
2296
+ title: Direction
2297
+ enum:
2298
+ - src
2299
+ - dst
2300
+ - either
2301
+ type: string
2302
+ description: 'direction - The direction of the populator. Valid values: "src", "dst", or "either".'
2303
+ fastData:
2304
+ title: fastData
2305
+ enum:
2306
+ - Auto
2307
+ - Fast
2308
+ - Full
2309
+ type: string
2310
+ description: fastData - Overrides the default setting for the dataset on which to run the query. See https://www.kentik.com/KB/?Ab04.htm#Ab04-Query_Dataset_Selection.
2311
+ filtergroup:
2312
+ title: filtergroup
2313
+ required:
2314
+ - connector
2315
+ type: object
2316
+ properties:
2317
+ connector:
2318
+ $ref: '#/components/schemas/connector'
2319
+ filters:
2320
+ type: array
2321
+ items:
2322
+ $ref: '#/components/schemas/filter'
2323
+ description: filters - //
2324
+ not:
2325
+ type: boolean
2326
+ description: not - Whether or not to NOT() the filter group.
2327
+ default: false
2328
+ filter:
2329
+ title: filter
2330
+ required:
2331
+ - filterField
2332
+ - operator
2333
+ type: object
2334
+ properties:
2335
+ filterField:
2336
+ $ref: '#/components/schemas/filterField'
2337
+ operator:
2338
+ $ref: '#/components/schemas/operator'
2339
+ filterValue:
2340
+ type: string
2341
+ description: filterValue - An operand input by the user.
2342
+ filterField:
2343
+ title: filterField
2344
+ enum:
2345
+ - src_geo
2346
+ - src_geo_region
2347
+ - src_geo_city
2348
+ - src_as
2349
+ - src_flow_tags
2350
+ - l4_src_port
2351
+ - vlan_in
2352
+ - src_eth_mac
2353
+ - inet_src_addr
2354
+ - input_port
2355
+ - i_input_snmp_alias
2356
+ - i_input_interface_description
2357
+ - ipv4_src_route_prefix
2358
+ - src_route_length
2359
+ - src_bgp_aspath
2360
+ - src_bgp_community
2361
+ - ipv4_src_next_hop
2362
+ - src_nexthop_as
2363
+ - src_second_asn
2364
+ - src_third_asn
2365
+ - dst_geo
2366
+ - dst_geo_region
2367
+ - dst_geo_city
2368
+ - dst_as
2369
+ - dst_flow_tags
2370
+ - l4_dst_port
2371
+ - vlan_out
2372
+ - dst_eth_mac
2373
+ - inet_dst_addr
2374
+ - output_port
2375
+ - i_output_snmp_alias
2376
+ - i_output_interface_description
2377
+ - ipv4_dst_route_prefix
2378
+ - dst_route_length
2379
+ - dst_bgp_aspath
2380
+ - dst_bgp_community
2381
+ - ipv4_dst_next_hop
2382
+ - dst_nexthop_as
2383
+ - dst_second_asn
2384
+ - dst_third_asn
2385
+ - tcp_flags
2386
+ - tcp_flags_raw
2387
+ - protocol
2388
+ - i_device_name
2389
+ - both_pkts
2390
+ - tcp_retransmit
2391
+ - tos
2392
+ type: string
2393
+ description: filterField - A field operand.
2394
+ filters:
2395
+ title: filters
2396
+ required:
2397
+ - connector
2398
+ - filterGroups
2399
+ type: object
2400
+ properties:
2401
+ connector:
2402
+ $ref: '#/components/schemas/connector'
2403
+ filterGroups:
2404
+ type: array
2405
+ items:
2406
+ $ref: '#/components/schemas/filtergroup'
2407
+ description: ''
2408
+ description: filters - //
2409
+ filters_obj:
2410
+ title: filters_obj
2411
+ required:
2412
+ - connector
2413
+ - filterGroups
2414
+ type: object
2415
+ properties:
2416
+ connector:
2417
+ $ref: '#/components/schemas/connector'
2418
+ filterGroups:
2419
+ type: array
2420
+ items:
2421
+ $ref: '#/components/schemas/filtergroup'
2422
+ description: ''
2423
+ description: filters_obj - //
2424
+ fn:
2425
+ title: fn
2426
+ enum:
2427
+ - sum
2428
+ - average
2429
+ - percentile
2430
+ - max
2431
+ - composite
2432
+ - exponent
2433
+ - modulus
2434
+ - greaterThan
2435
+ - greaterThanEquals
2436
+ - lessThan
2437
+ - lessThanEquals
2438
+ - equals
2439
+ - notEquals
2440
+ type: string
2441
+ description: fn - Aggregation function you want to run against 'column'.
2442
+ imageType:
2443
+ title: imageType
2444
+ enum:
2445
+ - pdf
2446
+ - png
2447
+ - jpg
2448
+ - svg
2449
+ type: string
2450
+ description: imageType - Type of image
2451
+ KentikPortalVersion:
2452
+ title: KentikPortalVersion
2453
+ enum:
2454
+ - 2
2455
+ - 3
2456
+ - 4
2457
+ type: integer
2458
+ description: Generates a URL for a particular version of Kentik
2459
+ Labelid:
2460
+ title: Labelid
2461
+ type: object
2462
+ properties:
2463
+ id:
2464
+ type: number
2465
+ description: id - Label id to be applied to the device.
2466
+ metric:
2467
+ title: metric
2468
+ enum:
2469
+ - bytes
2470
+ - in_bytes
2471
+ - out_bytes
2472
+ - packets
2473
+ - in_packets
2474
+ - out_packets
2475
+ - tcp_retransmit
2476
+ - perc_retransmit
2477
+ - retransmits_in
2478
+ - perc_retransmits_in
2479
+ - out_of_order_in
2480
+ - perc_out_of_order_in
2481
+ - fragments
2482
+ - perc_fragments
2483
+ - client_latency
2484
+ - server_latency
2485
+ - appl_latency
2486
+ - fps
2487
+ - unique_src_ip
2488
+ - unique_dst_ip
2489
+ type: string
2490
+ description: metric - Unit of measure, e.g. bytes, packets, etc.
2491
+ operator:
2492
+ title: operator
2493
+ enum:
2494
+ - =
2495
+ - <>
2496
+ - ILIKE
2497
+ - NOT ILIKE
2498
+ - ~
2499
+ - '!~'
2500
+ - '>'
2501
+ - <
2502
+ - '&'
2503
+ type: string
2504
+ description: operator - An operator.
2505
+ Populator:
2506
+ title: Populator
2507
+ required:
2508
+ - value
2509
+ - direction
2510
+ type: object
2511
+ properties:
2512
+ value:
2513
+ type: string
2514
+ description: "value - The value of the dimension. When the custom dimension's type is \"string\" - Valid characters: alphanumeric, spaces, dashes and underscores. Length: min=1, max=128. When the custom dimension's type is \"uint32\" - Valid values: min=0, max=4294967295."
2515
+ direction:
2516
+ $ref: '#/components/schemas/Direction'
2517
+ device_name:
2518
+ type: string
2519
+ description: device_name - A comma-separated list of device names, IPs, or regular expressions. A match results when any specified device name matches the device name or IP address associated with a device sending flow data.
2520
+ device_type:
2521
+ type: string
2522
+ description: device_type - A comma-separated list of device types or regular expressions. A match results when any specified device type matches the device_type associated with a device sending flow data.
2523
+ site:
2524
+ type: string
2525
+ description: site - A comma-separated list of sites or regular expressions. A match results when any specified site matches the site associated with a device sending flow data.
2526
+ interface_name:
2527
+ type: string
2528
+ description: interface_name - A comma-separated list of interface names or regular expressions. A match results when any specified interface name matches the name or description of an interface sending flow data.
2529
+ addr:
2530
+ type: string
2531
+ description: addr - A comma-separated list of IP addresses in IP/CIDR format. A match results when any specified IP address corresponds to a range of IP addresses in incoming flow. It allows IPv6 CIDRs. 'short form' (e.g. 1::2/127) is allowed. If no CIDRs are specified in a tag, the tag will be matched against both incoming IPv4 and v6 flows. If CIDRs are given, the tag will only be matched against the given type of flow; in particular, if you only give IPv4 CIDRs, the tag will not match any IPv6 flows, and vice versa.
2532
+ port:
2533
+ type: string
2534
+ description: port - A comma-separated list of number of ports (between 0 and 65535). A match results when any specified port matches a port number in incoming flow.
2535
+ tcp_flags:
2536
+ type: string
2537
+ description: tcp_flags - An integer number between 0 and 255 representing an 8-bit binary bit pattern corresponding to TCP flags. A match will result if the value in both the flow bit pattern and the bitmask is 1 at any of the eight places.
2538
+ protocol:
2539
+ type: string
2540
+ description: protocol - A comma-separated list of protocol numbers (between 0 and 255). A match results when any specified protocol number is the same as the protocol of the traffic represented by the flow.
2541
+ asn:
2542
+ type: string
2543
+ description: asn - A comma-separated list of ASNs (between 1 and 2^32-1=4294967295). A match results when any specified ASN is the same as the last ASN in the path in the routing table for either the source (SRC IP) or destination (DST IP).
2544
+ lasthop_as_name:
2545
+ type: string
2546
+ description: lasthop_as_name - A comma-separated list of AS Names or regular expressions. A match results when any specified AS Name represents the name corresponding to the last ASN in the path in the routing table for either the source (SRC IP) or destination (DST IP).
2547
+ nexthop_asn:
2548
+ type: string
2549
+ description: nexthop_asn - A comma-separated list of ASNs (between 1 and 2^32-1=4294967295). A match results when any specified ASN is the same as the ASN of the next hop router based on AS path.
2550
+ nexthop_as_name:
2551
+ type: string
2552
+ description: nexthop_as_name - A comma-separated list of AS Names or regular expressions. A match results when any specified ASN represents the name corresponding to the ASN of the next hop router based on AS path.
2553
+ nexthop:
2554
+ type: string
2555
+ description: nexthop - A comma-separated list of IPv4 and/or IPv6 CIDRs. A match results when any specified IP is within a range of specified IPv4 and/or IPv6 CIDRs.
2556
+ bgp_aspath:
2557
+ type: string
2558
+ description: 'bgp_aspath - A comma-separated list of numbers representing bgp aspath. A match results when any specified value is the same as the BGP AS-PATH in the route. Example: "^3737 1212,_7801_,2906$" would look for any of those 3 combinations in the AS path. Permitted characters []*:_^$.0123456789()+?,space-'
2559
+ bgp_community:
2560
+ type: string
2561
+ description: bgp_community - A comma-separated list of numbers or regular expression representing BGP community (i.e. 2096:2212). A match results when any specified value is the same as the BGP community of the BGP route associated with incoming flow data. Permitted characters []*:_^$.0123456789()+?,space-
2562
+ mac:
2563
+ type: string
2564
+ description: mac - A comma-separated list of MAC Addresses. A match results when any specified MAC Address matches source or destination Ethernet (L2) address.
2565
+ country:
2566
+ type: string
2567
+ description: country - A comma-separated list of two-character country codes. A match results when any specified country code matches source or destination country of the flow.
2568
+ vlans:
2569
+ type: string
2570
+ description: vlans - A comma delimited list of integers or ranges of integers between 0 and 4095.
2571
+ PrivacyProtocol:
2572
+ title: PrivacyProtocol
2573
+ enum:
2574
+ - NoPriv
2575
+ - DES
2576
+ - AES
2577
+ type: string
2578
+ description: PrivacyProtocol - the privacy protocol to use to authenticate via SNMP v3
2579
+ query:
2580
+ title: query
2581
+ type: object
2582
+ properties:
2583
+ query:
2584
+ $ref: '#/components/schemas/Query12'
2585
+ bucket:
2586
+ type: string
2587
+ description: bucket - Name of 'bucket' to return data. A bucket runs all queries simultaneously. Queries not at bucketIndex 0 inherit certain values from the query at bucketIndex 0.
2588
+ bucketIndex:
2589
+ type: number
2590
+ description: 'bucketIndex - A bucket index. Valid value: digit 0 or greater than 0.'
2591
+ query1:
2592
+ title: query1
2593
+ required:
2594
+ - dimension
2595
+ - metric
2596
+ - topx
2597
+ - depth
2598
+ - fastData
2599
+ - outsort
2600
+ - lookback_seconds
2601
+ - time_format
2602
+ - device_name
2603
+ type: object
2604
+ properties:
2605
+ dimension:
2606
+ type: array
2607
+ items:
2608
+ $ref: '#/components/schemas/dimension'
2609
+ description: ''
2610
+ cidr:
2611
+ type: number
2612
+ description: 'cidr - A CIDR filter to use on IP queries, such as when grouping by dest_ip/24. See https://www.kentik.com/KB/?Eb02.htm#Eb02-CIDRrelated_Subqueries. Valid values: digit between 0 and 32.'
2613
+ cidr6:
2614
+ type: number
2615
+ description: 'cidr6 - A CIDR6 filter to use on IP queries. Valid values: digit between 0 and 128.'
2616
+ pps_threshold:
2617
+ type: number
2618
+ description: 'pps_threshold - The minimum packets per second required to match flow (used in conjunction with metrics like retransmits, out of order, etc). Valid value: digit greater than 0.'
2619
+ metric:
2620
+ $ref: '#/components/schemas/metric'
2621
+ topx:
2622
+ type: number
2623
+ description: 'topx - The number of results you want to see on your chart / get chart data for. Valid value: digit between 1 and 40.'
2624
+ depth:
2625
+ type: number
2626
+ description: 'depth - The number of rows you want to retrieve (topX but aggregates only). Valid value: digit between 25 and 250.'
2627
+ fastData:
2628
+ $ref: '#/components/schemas/fastData'
2629
+ outsort:
2630
+ type: string
2631
+ description: "outsort - This maps to an aggregate name (see aggregates below). Common ones are: 'avg', 'sum', 'max', 'p95th'; what aggregate column to sort the results by to produce a topx/depth."
2632
+ lookback_seconds:
2633
+ type: number
2634
+ description: lookback_seconds - The time period to look back from present, e.g. for time span of last 2 hours, set to 7200. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
2635
+ time_format:
2636
+ $ref: '#/components/schemas/timeformat'
2637
+ hostname_lookup:
2638
+ type: boolean
2639
+ description: hostname_lookup - Allow DNS lookup when checked (true). Queries against IP dimensions will run faster without allowing DNS lookup.
2640
+ default: true
2641
+ starting_time:
2642
+ type: string
2643
+ description: starting_time - The fixed start time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
2644
+ ending_time:
2645
+ type: string
2646
+ description: ending_time - The fixed ending time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
2647
+ device_name:
2648
+ type: string
2649
+ description: device_name - Sets the device against which to query. Multiple devices can be set using comma delimited string.
2650
+ all_selected:
2651
+ type: boolean
2652
+ description: all_selected - Whether or not you want us to query against all of your devices (if true, we ignore device_name)
2653
+ default: false
2654
+ filters_obj:
2655
+ $ref: '#/components/schemas/FiltersObj1'
2656
+ saved_filters:
2657
+ type: array
2658
+ items:
2659
+ $ref: '#/components/schemas/saved_filter'
2660
+ description: saved_filters - //
2661
+ descriptor:
2662
+ type: string
2663
+ description: descriptor - This effects the 'name' column returned when using the 'Traffic' dimension
2664
+ aggregates:
2665
+ type: array
2666
+ items:
2667
+ $ref: '#/components/schemas/aggregate'
2668
+ description: ''
2669
+ description: query - Query object.
2670
+ query3:
2671
+ title: query3
2672
+ required:
2673
+ - dimension
2674
+ - metric
2675
+ - topx
2676
+ - depth
2677
+ - fastData
2678
+ - outsort
2679
+ - lookback_seconds
2680
+ - device_name
2681
+ type: object
2682
+ properties:
2683
+ dimension:
2684
+ type: array
2685
+ items:
2686
+ $ref: '#/components/schemas/dimension'
2687
+ description: ''
2688
+ cidr:
2689
+ type: number
2690
+ description: 'cidr - A CIDR filter to use on IP queries, such as when grouping by dest_ip/24. See https://www.kentik.com/KB/?Eb02.htm#Eb02-CIDRrelated_Subqueries. Valid values: digit between 0 and 32.'
2691
+ cidr6:
2692
+ type: number
2693
+ description: 'cidr6 - A CIDR6 filter to use on IP queries. Valid values: digit between 0 and 128.'
2694
+ pps_threshold:
2695
+ type: number
2696
+ description: 'pps_threshold - The minimum packets per second required to match flow (used in conjunction with metrics like retransmits, out of order, etc). Valid value: digit greater than 0.'
2697
+ metric:
2698
+ $ref: '#/components/schemas/metric'
2699
+ topx:
2700
+ type: number
2701
+ description: 'topx - The number of results you want to see on your chart / get chart data for. Valid value: digit between 1 and 40.'
2702
+ depth:
2703
+ type: number
2704
+ description: 'depth - The number of rows you want to retrieve (topX but aggregates only). Valid value: digit between 25 and 250.'
2705
+ fastData:
2706
+ $ref: '#/components/schemas/fastData'
2707
+ outsort:
2708
+ type: string
2709
+ description: "outsort - This maps to an aggregate name (see aggregates below). Common ones are: 'avg', 'sum', 'max', 'p95th'; what aggregate column to sort the results by to produce a topx/depth."
2710
+ lookback_seconds:
2711
+ type: number
2712
+ description: lookback_seconds - The time period to look back from present, e.g. for time span of last 2 hours, set to 7200. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
2713
+ hostname_lookup:
2714
+ type: boolean
2715
+ description: hostname_lookup - Allow DNS lookup when checked (true). Queries against IP dimensions will run faster without allowing DNS lookup.
2716
+ default: true
2717
+ starting_time:
2718
+ type: string
2719
+ description: starting_time - The fixed start time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
2720
+ ending_time:
2721
+ type: string
2722
+ description: ending_time - The fixed ending time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
2723
+ device_name:
2724
+ type: string
2725
+ description: device_name - Sets the device against which to query. Multiple devices can be set using comma delimited string.
2726
+ all_selected:
2727
+ type: boolean
2728
+ description: all_selected - Whether or not you want us to query against all of your devices (if true, we ignore device_name)
2729
+ default: false
2730
+ filters_obj:
2731
+ $ref: '#/components/schemas/FiltersObj1'
2732
+ saved_filters:
2733
+ type: array
2734
+ items:
2735
+ $ref: '#/components/schemas/saved_filter'
2736
+ description: saved_filters - //
2737
+ descriptor:
2738
+ type: string
2739
+ description: descriptor - This effects the 'name' column returned when using the 'Traffic' dimension
2740
+ aggregates:
2741
+ type: array
2742
+ items:
2743
+ $ref: '#/components/schemas/aggregate'
2744
+ description: ''
2745
+ description: query - Query object.
2746
+ query5:
2747
+ title: query5
2748
+ required:
2749
+ - dimension
2750
+ - metric
2751
+ - topx
2752
+ - depth
2753
+ - fastData
2754
+ - outsort
2755
+ - lookback_seconds
2756
+ - device_name
2757
+ type: object
2758
+ properties:
2759
+ viz_type:
2760
+ type: string
2761
+ description: viz_type - The chart type.
2762
+ show_overlay:
2763
+ type: boolean
2764
+ description: show_overlay - Whether or not to show a historical overlay (if supported by viz_type)
2765
+ default: false
2766
+ overlay_day:
2767
+ type: number
2768
+ description: overlay_day - Number of days to lookback for historical overlay.
2769
+ sync_axes:
2770
+ type: boolean
2771
+ description: sync_axes - For use with multiple data series; whether or not you want left and right axes scales to be synced.
2772
+ default: false
2773
+ dimension:
2774
+ type: array
2775
+ items:
2776
+ $ref: '#/components/schemas/dimension'
2777
+ description: ''
2778
+ cidr:
2779
+ type: number
2780
+ description: 'cidr - A CIDR filter to use on IP queries, such as when grouping by dest_ip/24. See https://www.kentik.com/KB/?Eb02.htm#Eb02-CIDRrelated_Subqueries. Valid values: digit between 0 and 32.'
2781
+ cidr6:
2782
+ type: number
2783
+ description: 'cidr6 - A CIDR6 filter to use on IP queries. Valid values: digit between 0 and 128.'
2784
+ pps_threshold:
2785
+ type: number
2786
+ description: 'pps_threshold - The minimum packets per second required to match flow (used in conjunction with metrics like retransmits, out of order, etc). Valid value: digit greater than 0.'
2787
+ metric:
2788
+ $ref: '#/components/schemas/metric'
2789
+ topx:
2790
+ type: number
2791
+ description: 'topx - The number of results you want to see on your chart / get chart data for. Valid value: digit between 1 and 40.'
2792
+ depth:
2793
+ type: number
2794
+ description: 'depth - The number of rows you want to retrieve (topX but aggregates only). Valid value: digit between 25 and 250.'
2795
+ fastData:
2796
+ $ref: '#/components/schemas/fastData'
2797
+ outsort:
2798
+ type: string
2799
+ description: "outsort - This maps to an aggregate name (see aggregates below). Common ones are: 'avg', 'sum', 'max', 'p95th'; what aggregate column to sort the results by to produce a topx/depth."
2800
+ lookback_seconds:
2801
+ type: number
2802
+ description: lookback_seconds - The time period to look back from present, e.g. for time span of last 2 hours, set to 7200. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
2803
+ hostname_lookup:
2804
+ type: boolean
2805
+ description: hostname_lookup - Allow DNS lookup when checked (true). Queries against IP dimensions will run faster without allowing DNS lookup.
2806
+ default: true
2807
+ starting_time:
2808
+ type: string
2809
+ description: starting_time - The fixed start time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
2810
+ ending_time:
2811
+ type: string
2812
+ description: ending_time - The fixed ending time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
2813
+ device_name:
2814
+ type: string
2815
+ description: device_name - Sets the device against which to query. Multiple devices can be set using comma delimited string.
2816
+ all_selected:
2817
+ type: boolean
2818
+ description: all_selected - Whether or not you want us to query against all of your devices (if true, we ignore device_name)
2819
+ default: false
2820
+ filters_obj:
2821
+ $ref: '#/components/schemas/FiltersObj1'
2822
+ saved_filters:
2823
+ type: array
2824
+ items:
2825
+ $ref: '#/components/schemas/saved_filter'
2826
+ description: saved_filters - //
2827
+ descriptor:
2828
+ type: string
2829
+ description: descriptor - This effects the 'name' column returned when using the 'Traffic' dimension
2830
+ aggregates:
2831
+ type: array
2832
+ items:
2833
+ $ref: '#/components/schemas/aggregate'
2834
+ description: ''
2835
+ query_title:
2836
+ type: string
2837
+ description: query_title - The query's title.
2838
+ description: query - Query object.
2839
+ query2:
2840
+ title: query2
2841
+ type: object
2842
+ properties:
2843
+ query:
2844
+ $ref: '#/components/schemas/Query32'
2845
+ bucket:
2846
+ type: string
2847
+ description: bucket - Name of 'bucket' to return data. A bucket runs all queries simultaneously. Queries not at bucketIndex 0 inherit certain values from the query at bucketIndex 0.
2848
+ bucketIndex:
2849
+ type: number
2850
+ description: 'bucketIndex - A bucket index. Valid value: digit 0 or greater than 0.'
2851
+ query4:
2852
+ title: query4
2853
+ type: object
2854
+ properties:
2855
+ query:
2856
+ $ref: '#/components/schemas/Query52'
2857
+ bucket:
2858
+ type: string
2859
+ description: bucket - Name of 'bucket' to return data. A bucket runs all queries simultaneously. Queries not at bucketIndex 0 inherit certain values from the query at bucketIndex 0.
2860
+ bucketIndex:
2861
+ type: number
2862
+ description: 'bucketIndex - A bucket index. Valid value: digit 0 or greater than 0.'
2863
+ isOverlay:
2864
+ type: boolean
2865
+ description: isOverlay - Whether or not query should be treated like an overlay
2866
+ default: false
2867
+ rightOperand:
2868
+ title: rightOperand
2869
+ enum:
2870
+ - sum
2871
+ - subtract
2872
+ - multiply
2873
+ - divide
2874
+ type: string
2875
+ description: rightOperand - Value for right side of composite equation; used only for 'composite' fn
2876
+ saved_filter:
2877
+ title: saved_filter
2878
+ type: object
2879
+ properties:
2880
+ filter_id:
2881
+ type: number
2882
+ description: filter_id - Id of saved filter you want to use
2883
+ isNot:
2884
+ type: boolean
2885
+ description: isNot - Whether or not to NOT() the saved filter
2886
+ default: false
2887
+ description: saved_filters - //
2888
+ SecondaryIP:
2889
+ title: SecondaryIP
2890
+ type: object
2891
+ properties:
2892
+ address:
2893
+ type: string
2894
+ description: address - A secondary IP address for the interface.
2895
+ netmask:
2896
+ type: string
2897
+ description: netmask - Netmask for the associated secondary IP.
2898
+ Site:
2899
+ title: Site
2900
+ required:
2901
+ - site_name
2902
+ type: object
2903
+ properties:
2904
+ site_name:
2905
+ type: string
2906
+ description: 'site_name - The name of the site. Valid characters: alphanumeric, spaces and underscores. Length: min=3, max=40.'
2907
+ lat:
2908
+ type: number
2909
+ description: 'lat - The latitude of the site. Valid values: min=-90, max=90.'
2910
+ lon:
2911
+ type: number
2912
+ description: 'lon - The longitude of the site. Valid values: min=-180, max=180.'
2913
+ Site1:
2914
+ title: Site1
2915
+ type: object
2916
+ properties:
2917
+ site_name:
2918
+ type: string
2919
+ description: 'site_name - The name of the site. Valid characters: alphanumeric, spaces and underscores. Length: min=3, max=40.'
2920
+ lat:
2921
+ type: number
2922
+ description: 'lat - The latitude of the site. Valid values: min=-90, max=90.'
2923
+ lon:
2924
+ type: number
2925
+ description: 'lon - The longitude of the site. Valid values: min=-180, max=180.'
2926
+ SNMPv3Authentication:
2927
+ title: SNMPv3Authentication
2928
+ required:
2929
+ - AuthenticationProtocol
2930
+ - PrivacyProtocol
2931
+ type: object
2932
+ properties:
2933
+ UserName:
2934
+ type: string
2935
+ description: UserName - the user name to use to authenticate via SNMP v3. ** UserName is required when device_snmp_v3_conf is not null
2936
+ AuthenticationProtocol:
2937
+ $ref: '#/components/schemas/AuthenticationProtocol'
2938
+ AuthenticationPassphrase:
2939
+ type: string
2940
+ description: AuthenticationPassphrase - the passphrase to use for SNMP v3 authentication protocol (required when AuthenticationProtocol not NoAuth)
2941
+ PrivacyProtocol:
2942
+ $ref: '#/components/schemas/PrivacyProtocol'
2943
+ PrivacyPassphrase:
2944
+ type: string
2945
+ description: PrivacyPassphrase - the passphrase to use for SNMP v3 privacy protocol (required when PrivacyProtocol not NoPriv)
2946
+ description: device_snmp_v3_conf - Include this configuration to enable SNMP v3 authentication protocols. This supercedes SNMP Community.
2947
+ SNMPv3Authentication1:
2948
+ title: SNMPv3Authentication1
2949
+ type: object
2950
+ properties:
2951
+ UserName:
2952
+ type: string
2953
+ description: UserName - the user name to use to authenticate via SNMP v3.
2954
+ AuthenticationProtocol:
2955
+ $ref: '#/components/schemas/AuthenticationProtocol'
2956
+ AuthenticationPassphrase:
2957
+ type: string
2958
+ description: AuthenticationPassphrase - the passphrase to use for SNMP v3 authentication protocol (required when AuthenticationProtocol not NoAuth)
2959
+ PrivacyProtocol:
2960
+ $ref: '#/components/schemas/PrivacyProtocol'
2961
+ PrivacyPassphrase:
2962
+ type: string
2963
+ description: PrivacyPassphrase - the passphrase to use for SNMP v3 privacy protocol (required when PrivacyProtocol not NoPriv)
2964
+ description: device_snmp_v3_conf - Include this configuration to enable SNMP v3 authentication protocols. This supercedes SNMP Community.
2965
+ Tag:
2966
+ title: Tag
2967
+ required:
2968
+ - flow_tag
2969
+ type: object
2970
+ properties:
2971
+ flow_tag:
2972
+ type: string
2973
+ description: flow_tag - A name for the tag. When a match for any of the other tag parameters is found in the flow from a given device, this string will be added to the src_flow_tags and/or dst_flow_tags column in that device's KDE main table.
2974
+ device_name:
2975
+ type: string
2976
+ description: device_name - A comma-separated list of device names, IPs, or regular expressions. A match results when any specified device name matches the device name or IP address associated with a device sending flow data.
2977
+ device_type:
2978
+ type: string
2979
+ description: device_type - A comma-separated list of device types or regular expressions. A match results when any specified device type matches the device_type associated with a device sending flow data.
2980
+ site:
2981
+ type: string
2982
+ description: site - A comma-separated list of sites or regular expressions. A match results when any specified site matches the site associated with a device sending flow data.
2983
+ interface_name:
2984
+ type: string
2985
+ description: interface_name - A comma-separated list of interface names or regular expressions. A match results when any specified interface name matches the name or description of an interface sending flow data.
2986
+ addr:
2987
+ type: string
2988
+ description: addr - A comma-separated list of IP addresses in IP/CIDR format. A match results when any specified IP address corresponds to a range of IP addresses in incoming flow. It allows IPv6 CIDRs. 'short form' (e.g. 1::2/127) is allowed. If no CIDRs are specified in a tag, the tag will be matched against both incoming IPv4 and v6 flows. If CIDRs are given, the tag will only be matched against the given type of flow; in particular, if you only give IPv4 CIDRs, the tag will not match any IPv6 flows, and vice versa.
2989
+ port:
2990
+ type: string
2991
+ description: port - A comma-separated list of number of ports (between 0 and 65535). A match results when any specified port matches a port number in incoming flow.
2992
+ tcp_flags:
2993
+ type: string
2994
+ description: tcp_flags - An integer number between 0 and 255 representing an 8-bit binary bit pattern corresponding to TCP flags. A match will result if the value in both the flow bit pattern and the bitmask is 1 at any of the eight places.
2995
+ protocol:
2996
+ type: string
2997
+ description: protocol - A comma-separated list of protocol numbers (between 0 and 255). A match results when any specified protocol number is the same as the protocol of the traffic represented by the flow.
2998
+ asn:
2999
+ type: string
3000
+ description: asn - A comma-separated list of ASNs (between 1 and 2^32-1=4294967295). A match results when any specified ASN is the same as the last ASN in the path in the routing table for either the source (SRC IP) or destination (DST IP).
3001
+ lasthop_as_name:
3002
+ type: string
3003
+ description: lasthop_as_name - A comma-separated list of AS Names or regular expressions. A match results when any specified AS Name represents the name corresponding to the last ASN in the path in the routing table for either the source (SRC IP) or destination (DST IP).
3004
+ nexthop_asn:
3005
+ type: string
3006
+ description: nexthop_asn - A comma-separated list of ASNs (between 1 and 2^32-1=4294967295). A match results when any specified ASN is the same as the ASN of the next hop router based on AS path.
3007
+ nexthop_as_name:
3008
+ type: string
3009
+ description: nexthop_as_name - A comma-separated list of AS Names or regular expressions. A match results when any specified ASN represents the name corresponding to the ASN of the next hop router based on AS path.
3010
+ nexthop:
3011
+ type: string
3012
+ description: nexthop - A comma-separated list of IPv4 and/or IPv6 CIDRs. A match results when any specified IP is within a range of specified IPv4 and/or IPv6 CIDRs.
3013
+ bgp_aspath:
3014
+ type: string
3015
+ description: 'bgp_aspath - A comma-separated list of numbers representing bgp aspath. A match results when any specified value is the same as the BGP AS-PATH in the route. Example: "^3737 1212,_7801_,2906$" would look for any of those 3 combinations in the AS path. Permitted characters []*:_^$.0123456789()+?,space-'
3016
+ bgp_community:
3017
+ type: string
3018
+ description: bgp_community - A comma-separated list of numbers or regular expression representing BGP community (i.e. 2096:2212). A match results when any specified value is the same as the BGP community of the BGP route associated with incoming flow data. Permitted characters []*:_^$.0123456789()+?,space-
3019
+ mac:
3020
+ type: string
3021
+ description: mac - A comma-separated list of MAC Addresses. A match results when any specified MAC Address matches source or destination Ethernet (L2) address.
3022
+ country:
3023
+ type: string
3024
+ description: country - A comma-separated list of two-character country codes. A match results when any specified country code matches source or destination country of the flow.
3025
+ vlans:
3026
+ type: string
3027
+ description: vlans - A comma delimited list of integers or ranges of integers between 0 and 4095.
3028
+ timeformat:
3029
+ title: timeformat
3030
+ enum:
3031
+ - UTC
3032
+ - Local
3033
+ type: string
3034
+ description: time_format - The time zone in which times are expressed, either UTC or local.
3035
+ Type:
3036
+ title: Type
3037
+ enum:
3038
+ - string
3039
+ - uint32
3040
+ type: string
3041
+ description: 'type - The type of the custom dimension. Valid values: "string" or "uint32".'
3042
+ User:
3043
+ title: User
3044
+ required:
3045
+ - user_email
3046
+ - role
3047
+ - email_product
3048
+ - email_service
3049
+ type: object
3050
+ properties:
3051
+ user_email:
3052
+ type: string
3053
+ description: user_email - A valid email address for the user.
3054
+ user_full_name:
3055
+ type: string
3056
+ description: "user_full_name - The user's full name. Valid characters: all except double quotes. Length: max=50."
3057
+ role:
3058
+ $ref: '#/components/schemas/Userrole'
3059
+ email_product:
3060
+ type: boolean
3061
+ description: 'email_product - Determines whether the user will receive emails about Kentik Detect product upgrades (e.g. updates to features, interface, capabilities, etc.): true if yes, false if no.'
3062
+ email_service:
3063
+ type: boolean
3064
+ description: 'email_service - Determines whether the user will receive emails about Kentik Detect service status (e.g. scheduled maintenance, etc.): true if yes, false if no.'
3065
+ Userrole:
3066
+ title: Userrole
3067
+ enum:
3068
+ - Administrator
3069
+ - Member
3070
+ type: string
3071
+ description: "role - The user's role. Valid values: Member (0) or Administrator (1)."
3072
+ User1:
3073
+ title: User1
3074
+ required:
3075
+ - role
3076
+ type: object
3077
+ properties:
3078
+ user_email:
3079
+ type: string
3080
+ description: user_email - A valid email address for the user. Changes will send a verification message to the updated address. The new address will only appear after user has completed verification.
3081
+ user_full_name:
3082
+ type: string
3083
+ description: "user_full_name - The user's full name. Valid characters: all except double quotes. Length: max=50."
3084
+ role:
3085
+ $ref: '#/components/schemas/Userrole'
3086
+ email_product:
3087
+ type: boolean
3088
+ description: 'email_product - Determines whether the user will receive emails about Kentik Detect product upgrades (e.g. updates to features, interface, capabilities, etc.): true if yes, false if no.'
3089
+ default: true
3090
+ email_service:
3091
+ type: boolean
3092
+ description: 'email_service - Determines whether the user will receive emails about Kentik Detect service status (e.g. scheduled maintenance, etc.): true if yes, false if no.'
3093
+ default: true
3094
+ User2:
3095
+ title: User2
3096
+ required:
3097
+ - user_email
3098
+ type: object
3099
+ properties:
3100
+ user_email:
3101
+ type: string
3102
+ description: user_email - A valid email address for the user.
3103
+ VRF:
3104
+ title: VRF
3105
+ required:
3106
+ - name
3107
+ - description
3108
+ - route_target
3109
+ - route_distinguisher
3110
+ type: object
3111
+ properties:
3112
+ name:
3113
+ type: string
3114
+ description: name - Name of the VRF entry.
3115
+ description:
3116
+ type: string
3117
+ description: description - Description of the VRF entry.
3118
+ route_target:
3119
+ type: string
3120
+ description: route_target - Route Target Community of the VRF entry.
3121
+ route_distinguisher:
3122
+ type: string
3123
+ description: route_distinguisher - Route Distinguisher of the VRF entry.
3124
+ ext_route_distinguisher:
3125
+ type: number
3126
+ description: ext_route_distinguisher - External Route Distinguisher of the VRF entry.
3127
+ DeviceSnmpV3Conf:
3128
+ title: DeviceSnmpV3Conf
3129
+ required:
3130
+ - AuthenticationProtocol
3131
+ - PrivacyProtocol
3132
+ type: object
3133
+ properties:
3134
+ UserName:
3135
+ type: string
3136
+ description: UserName - the user name to use to authenticate via SNMP v3. ** UserName is required when device_snmp_v3_conf is not null
3137
+ AuthenticationProtocol:
3138
+ $ref: '#/components/schemas/AuthenticationProtocol'
3139
+ AuthenticationPassphrase:
3140
+ type: string
3141
+ description: AuthenticationPassphrase - the passphrase to use for SNMP v3 authentication protocol (required when AuthenticationProtocol not NoAuth)
3142
+ PrivacyProtocol:
3143
+ $ref: '#/components/schemas/PrivacyProtocol'
3144
+ PrivacyPassphrase:
3145
+ type: string
3146
+ description: PrivacyPassphrase - the passphrase to use for SNMP v3 privacy protocol (required when PrivacyProtocol not NoPriv)
3147
+ DeviceSnmpV3Conf1:
3148
+ title: DeviceSnmpV3Conf1
3149
+ type: object
3150
+ properties:
3151
+ UserName:
3152
+ type: string
3153
+ description: UserName - the user name to use to authenticate via SNMP v3.
3154
+ AuthenticationProtocol:
3155
+ $ref: '#/components/schemas/AuthenticationProtocol'
3156
+ AuthenticationPassphrase:
3157
+ type: string
3158
+ description: AuthenticationPassphrase - the passphrase to use for SNMP v3 authentication protocol (required when AuthenticationProtocol not NoAuth)
3159
+ PrivacyProtocol:
3160
+ $ref: '#/components/schemas/PrivacyProtocol'
3161
+ PrivacyPassphrase:
3162
+ type: string
3163
+ description: PrivacyPassphrase - the passphrase to use for SNMP v3 privacy protocol (required when PrivacyProtocol not NoPriv)
3164
+ Filters1:
3165
+ title: Filters1
3166
+ required:
3167
+ - connector
3168
+ - filterGroups
3169
+ type: object
3170
+ properties:
3171
+ connector:
3172
+ $ref: '#/components/schemas/connector'
3173
+ filterGroups:
3174
+ type: array
3175
+ items:
3176
+ $ref: '#/components/schemas/filtergroup'
3177
+ description: ''
3178
+ FiltersObj1:
3179
+ title: FiltersObj1
3180
+ required:
3181
+ - connector
3182
+ - filterGroups
3183
+ type: object
3184
+ properties:
3185
+ connector:
3186
+ $ref: '#/components/schemas/connector'
3187
+ filterGroups:
3188
+ type: array
3189
+ items:
3190
+ $ref: '#/components/schemas/filtergroup'
3191
+ description: ''
3192
+ Query12:
3193
+ title: Query12
3194
+ required:
3195
+ - dimension
3196
+ - metric
3197
+ - topx
3198
+ - depth
3199
+ - fastData
3200
+ - outsort
3201
+ - lookback_seconds
3202
+ - time_format
3203
+ - device_name
3204
+ type: object
3205
+ properties:
3206
+ dimension:
3207
+ type: array
3208
+ items:
3209
+ $ref: '#/components/schemas/dimension'
3210
+ description: ''
3211
+ cidr:
3212
+ type: number
3213
+ description: 'cidr - A CIDR filter to use on IP queries, such as when grouping by dest_ip/24. See https://www.kentik.com/KB/?Eb02.htm#Eb02-CIDRrelated_Subqueries. Valid values: digit between 0 and 32.'
3214
+ cidr6:
3215
+ type: number
3216
+ description: 'cidr6 - A CIDR6 filter to use on IP queries. Valid values: digit between 0 and 128.'
3217
+ pps_threshold:
3218
+ type: number
3219
+ description: 'pps_threshold - The minimum packets per second required to match flow (used in conjunction with metrics like retransmits, out of order, etc). Valid value: digit greater than 0.'
3220
+ metric:
3221
+ $ref: '#/components/schemas/metric'
3222
+ topx:
3223
+ type: number
3224
+ description: 'topx - The number of results you want to see on your chart / get chart data for. Valid value: digit between 1 and 40.'
3225
+ depth:
3226
+ type: number
3227
+ description: 'depth - The number of rows you want to retrieve (topX but aggregates only). Valid value: digit between 25 and 250.'
3228
+ fastData:
3229
+ $ref: '#/components/schemas/fastData'
3230
+ outsort:
3231
+ type: string
3232
+ description: "outsort - This maps to an aggregate name (see aggregates below). Common ones are: 'avg', 'sum', 'max', 'p95th'; what aggregate column to sort the results by to produce a topx/depth."
3233
+ lookback_seconds:
3234
+ type: number
3235
+ description: lookback_seconds - The time period to look back from present, e.g. for time span of last 2 hours, set to 7200. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
3236
+ time_format:
3237
+ $ref: '#/components/schemas/timeformat'
3238
+ hostname_lookup:
3239
+ type: boolean
3240
+ description: hostname_lookup - Allow DNS lookup when checked (true). Queries against IP dimensions will run faster without allowing DNS lookup.
3241
+ default: true
3242
+ starting_time:
3243
+ type: string
3244
+ description: starting_time - The fixed start time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
3245
+ ending_time:
3246
+ type: string
3247
+ description: ending_time - The fixed ending time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
3248
+ device_name:
3249
+ type: string
3250
+ description: device_name - Sets the device against which to query. Multiple devices can be set using comma delimited string.
3251
+ all_selected:
3252
+ type: boolean
3253
+ description: all_selected - Whether or not you want us to query against all of your devices (if true, we ignore device_name)
3254
+ default: false
3255
+ filters_obj:
3256
+ $ref: '#/components/schemas/FiltersObj1'
3257
+ saved_filters:
3258
+ type: array
3259
+ items:
3260
+ $ref: '#/components/schemas/saved_filter'
3261
+ description: saved_filters - //
3262
+ descriptor:
3263
+ type: string
3264
+ description: descriptor - This effects the 'name' column returned when using the 'Traffic' dimension
3265
+ aggregates:
3266
+ type: array
3267
+ items:
3268
+ $ref: '#/components/schemas/aggregate'
3269
+ description: ''
3270
+ Query32:
3271
+ title: Query32
3272
+ required:
3273
+ - dimension
3274
+ - metric
3275
+ - topx
3276
+ - depth
3277
+ - fastData
3278
+ - outsort
3279
+ - lookback_seconds
3280
+ - device_name
3281
+ type: object
3282
+ properties:
3283
+ dimension:
3284
+ type: array
3285
+ items:
3286
+ $ref: '#/components/schemas/dimension'
3287
+ description: ''
3288
+ cidr:
3289
+ type: number
3290
+ description: 'cidr - A CIDR filter to use on IP queries, such as when grouping by dest_ip/24. See https://www.kentik.com/KB/?Eb02.htm#Eb02-CIDRrelated_Subqueries. Valid values: digit between 0 and 32.'
3291
+ cidr6:
3292
+ type: number
3293
+ description: 'cidr6 - A CIDR6 filter to use on IP queries. Valid values: digit between 0 and 128.'
3294
+ pps_threshold:
3295
+ type: number
3296
+ description: 'pps_threshold - The minimum packets per second required to match flow (used in conjunction with metrics like retransmits, out of order, etc). Valid value: digit greater than 0.'
3297
+ metric:
3298
+ $ref: '#/components/schemas/metric'
3299
+ topx:
3300
+ type: number
3301
+ description: 'topx - The number of results you want to see on your chart / get chart data for. Valid value: digit between 1 and 40.'
3302
+ depth:
3303
+ type: number
3304
+ description: 'depth - The number of rows you want to retrieve (topX but aggregates only). Valid value: digit between 25 and 250.'
3305
+ fastData:
3306
+ $ref: '#/components/schemas/fastData'
3307
+ outsort:
3308
+ type: string
3309
+ description: "outsort - This maps to an aggregate name (see aggregates below). Common ones are: 'avg', 'sum', 'max', 'p95th'; what aggregate column to sort the results by to produce a topx/depth."
3310
+ lookback_seconds:
3311
+ type: number
3312
+ description: lookback_seconds - The time period to look back from present, e.g. for time span of last 2 hours, set to 7200. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
3313
+ hostname_lookup:
3314
+ type: boolean
3315
+ description: hostname_lookup - Allow DNS lookup when checked (true). Queries against IP dimensions will run faster without allowing DNS lookup.
3316
+ default: true
3317
+ starting_time:
3318
+ type: string
3319
+ description: starting_time - The fixed start time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
3320
+ ending_time:
3321
+ type: string
3322
+ description: ending_time - The fixed ending time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
3323
+ device_name:
3324
+ type: string
3325
+ description: device_name - Sets the device against which to query. Multiple devices can be set using comma delimited string.
3326
+ all_selected:
3327
+ type: boolean
3328
+ description: all_selected - Whether or not you want us to query against all of your devices (if true, we ignore device_name)
3329
+ default: false
3330
+ filters_obj:
3331
+ $ref: '#/components/schemas/FiltersObj1'
3332
+ saved_filters:
3333
+ type: array
3334
+ items:
3335
+ $ref: '#/components/schemas/saved_filter'
3336
+ description: saved_filters - //
3337
+ descriptor:
3338
+ type: string
3339
+ description: descriptor - This effects the 'name' column returned when using the 'Traffic' dimension
3340
+ aggregates:
3341
+ type: array
3342
+ items:
3343
+ $ref: '#/components/schemas/aggregate'
3344
+ description: ''
3345
+ Query52:
3346
+ title: Query52
3347
+ required:
3348
+ - dimension
3349
+ - metric
3350
+ - topx
3351
+ - depth
3352
+ - fastData
3353
+ - outsort
3354
+ - lookback_seconds
3355
+ - device_name
3356
+ type: object
3357
+ properties:
3358
+ viz_type:
3359
+ type: string
3360
+ description: viz_type - The chart type.
3361
+ show_overlay:
3362
+ type: boolean
3363
+ description: show_overlay - Whether or not to show a historical overlay (if supported by viz_type)
3364
+ default: false
3365
+ overlay_day:
3366
+ type: number
3367
+ description: overlay_day - Number of days to lookback for historical overlay.
3368
+ sync_axes:
3369
+ type: boolean
3370
+ description: sync_axes - For use with multiple data series; whether or not you want left and right axes scales to be synced.
3371
+ default: false
3372
+ dimension:
3373
+ type: array
3374
+ items:
3375
+ $ref: '#/components/schemas/dimension'
3376
+ description: ''
3377
+ cidr:
3378
+ type: number
3379
+ description: 'cidr - A CIDR filter to use on IP queries, such as when grouping by dest_ip/24. See https://www.kentik.com/KB/?Eb02.htm#Eb02-CIDRrelated_Subqueries. Valid values: digit between 0 and 32.'
3380
+ cidr6:
3381
+ type: number
3382
+ description: 'cidr6 - A CIDR6 filter to use on IP queries. Valid values: digit between 0 and 128.'
3383
+ pps_threshold:
3384
+ type: number
3385
+ description: 'pps_threshold - The minimum packets per second required to match flow (used in conjunction with metrics like retransmits, out of order, etc). Valid value: digit greater than 0.'
3386
+ metric:
3387
+ $ref: '#/components/schemas/metric'
3388
+ topx:
3389
+ type: number
3390
+ description: 'topx - The number of results you want to see on your chart / get chart data for. Valid value: digit between 1 and 40.'
3391
+ depth:
3392
+ type: number
3393
+ description: 'depth - The number of rows you want to retrieve (topX but aggregates only). Valid value: digit between 25 and 250.'
3394
+ fastData:
3395
+ $ref: '#/components/schemas/fastData'
3396
+ outsort:
3397
+ type: string
3398
+ description: "outsort - This maps to an aggregate name (see aggregates below). Common ones are: 'avg', 'sum', 'max', 'p95th'; what aggregate column to sort the results by to produce a topx/depth."
3399
+ lookback_seconds:
3400
+ type: number
3401
+ description: lookback_seconds - The time period to look back from present, e.g. for time span of last 2 hours, set to 7200. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
3402
+ hostname_lookup:
3403
+ type: boolean
3404
+ description: hostname_lookup - Allow DNS lookup when checked (true). Queries against IP dimensions will run faster without allowing DNS lookup.
3405
+ default: true
3406
+ starting_time:
3407
+ type: string
3408
+ description: starting_time - The fixed start time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
3409
+ ending_time:
3410
+ type: string
3411
+ description: ending_time - The fixed ending time of the query time-span, e.g. 'YYYY-MM-DD HH:mm:00'. If you want starting_time/ending_time to take effect, you MUST set lookback_seconds to zero.
3412
+ device_name:
3413
+ type: string
3414
+ description: device_name - Sets the device against which to query. Multiple devices can be set using comma delimited string.
3415
+ all_selected:
3416
+ type: boolean
3417
+ description: all_selected - Whether or not you want us to query against all of your devices (if true, we ignore device_name)
3418
+ default: false
3419
+ filters_obj:
3420
+ $ref: '#/components/schemas/FiltersObj1'
3421
+ saved_filters:
3422
+ type: array
3423
+ items:
3424
+ $ref: '#/components/schemas/saved_filter'
3425
+ description: saved_filters - //
3426
+ descriptor:
3427
+ type: string
3428
+ description: descriptor - This effects the 'name' column returned when using the 'Traffic' dimension
3429
+ aggregates:
3430
+ type: array
3431
+ items:
3432
+ $ref: '#/components/schemas/aggregate'
3433
+ description: ''
3434
+ query_title:
3435
+ type: string
3436
+ description: query_title - The query's title.
3437
+ tags:
3438
+ - name: Query Methods
3439
+ description: ''
3440
+ - name: user
3441
+ description: ''
3442
+ - name: device
3443
+ description: ''
3444
+ - name: device label
3445
+ description: ''
3446
+ - name: plan
3447
+ description: ''
3448
+ - name: site
3449
+ description: ''
3450
+ - name: tag
3451
+ description: ''
3452
+ - name: custom_dimension
3453
+ description: ''
3454
+ - name: custom_application
3455
+ description: ''
3456
+ - name: savedfilter
3457
+ description: ''
3458
+ - name: alerts
3459
+ description: ''
3460
+ - name: alerts_active
3461
+ description: ''
3462
+ - name: My Kentik Portal
3463
+ description: ''