@itentialopensource/adapter-meraki 1.0.4 → 1.2.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,3774 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: meraki
4
+ description: this is the swagger file for adapter-meraki
5
+ contact:
6
+ email: apiteam@swagger.io
7
+ version: '1.0.0'
8
+ servers:
9
+ - url: https://your.host.name.io/
10
+ variables: {}
11
+ - url: http://your.host.name.io/
12
+ variables: {}
13
+ paths:
14
+ /api/v0/networks/{networkId}/camera/qualityRetentionProfiles:
15
+ get:
16
+ tags:
17
+ - CameraQualityRetentionProfiles
18
+ summary: getNetworkCameraQualityRetentionProfiles
19
+ description: List the quality retention profiles for this network
20
+ operationId: getNetworkCameraQualityRetentionProfiles
21
+ parameters:
22
+ - name: networkId
23
+ in: path
24
+ description: networkId
25
+ required: true
26
+ style: simple
27
+ schema:
28
+ type: string
29
+ responses:
30
+ '200':
31
+ description: successful operation
32
+ headers: {}
33
+ content:
34
+ text/plain:
35
+ schema:
36
+ type: string
37
+ description: successful operation
38
+ deprecated: false
39
+ post:
40
+ tags:
41
+ - CameraQualityRetentionProfiles
42
+ summary: createNetworkCameraQualityRetentionProfile
43
+ description: Creates new quality retention profile for this network.
44
+ operationId: createNetworkCameraQualityRetentionProfile
45
+ parameters:
46
+ - name: networkId
47
+ in: path
48
+ description: networkId
49
+ required: true
50
+ style: simple
51
+ schema:
52
+ type: string
53
+ requestBody:
54
+ description: body
55
+ content:
56
+ text/plain:
57
+ schema:
58
+ type: string
59
+ description: body
60
+ required: false
61
+ responses:
62
+ '200':
63
+ description: successful operation
64
+ headers: {}
65
+ content:
66
+ text/plain:
67
+ schema:
68
+ type: string
69
+ description: successful operation
70
+ deprecated: false
71
+ /api/v0/networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}:
72
+ get:
73
+ tags:
74
+ - CameraQualityRetentionProfiles
75
+ summary: getNetworkCameraQualityRetentionProfile
76
+ description: Retrieve a single quality retention profile
77
+ operationId: getNetworkCameraQualityRetentionProfile
78
+ parameters:
79
+ - name: networkId
80
+ in: path
81
+ description: networkId
82
+ required: true
83
+ style: simple
84
+ schema:
85
+ type: string
86
+ - name: qualityRetentionProfileId
87
+ in: path
88
+ description: qualityRetentionProfileId
89
+ required: true
90
+ style: simple
91
+ schema:
92
+ type: string
93
+ responses:
94
+ '200':
95
+ description: successful operation
96
+ headers: {}
97
+ content:
98
+ text/plain:
99
+ schema:
100
+ type: string
101
+ description: successful operation
102
+ deprecated: false
103
+ put:
104
+ tags:
105
+ - CameraQualityRetentionProfiles
106
+ summary: updateNetworkCameraQualityRetentionProfile
107
+ description: Update an existing quality retention profile for this network.
108
+ operationId: updateNetworkCameraQualityRetentionProfile
109
+ parameters:
110
+ - name: networkId
111
+ in: path
112
+ description: networkId
113
+ required: true
114
+ style: simple
115
+ schema:
116
+ type: string
117
+ - name: qualityRetentionProfileId
118
+ in: path
119
+ description: qualityRetentionProfileId
120
+ required: true
121
+ style: simple
122
+ schema:
123
+ type: string
124
+ requestBody:
125
+ description: body
126
+ content:
127
+ text/plain:
128
+ schema:
129
+ type: string
130
+ description: body
131
+ required: false
132
+ responses:
133
+ '200':
134
+ description: successful operation
135
+ headers: {}
136
+ content:
137
+ text/plain:
138
+ schema:
139
+ type: string
140
+ description: successful operation
141
+ deprecated: false
142
+ delete:
143
+ tags:
144
+ - CameraQualityRetentionProfiles
145
+ summary: deleteNetworkCameraQualityRetentionProfile
146
+ description: Delete an existing quality retention profile for this network.
147
+ operationId: deleteNetworkCameraQualityRetentionProfile
148
+ parameters:
149
+ - name: networkId
150
+ in: path
151
+ description: networkId
152
+ required: true
153
+ style: simple
154
+ schema:
155
+ type: string
156
+ - name: qualityRetentionProfileId
157
+ in: path
158
+ description: qualityRetentionProfileId
159
+ required: true
160
+ style: simple
161
+ schema:
162
+ type: string
163
+ responses:
164
+ '200':
165
+ description: successful operation
166
+ headers: {}
167
+ content:
168
+ text/plain:
169
+ schema:
170
+ type: string
171
+ description: successful operation
172
+ deprecated: false
173
+ /api/v0/networks/{networkId}/cellularGateway/settings/connectivityMonitoringDestinations:
174
+ get:
175
+ tags:
176
+ - MGConnectivityMonitoringDestinations
177
+ summary: getNetworkCellularGatewaySettingsConnectivityMonitoringDestinations
178
+ description: Return the connectivity testing destinations for an MG network
179
+ operationId: getNetworkCellularGatewaySettingsConnectivityMonitoringDestinations
180
+ parameters:
181
+ - name: networkId
182
+ in: path
183
+ description: networkId
184
+ required: true
185
+ style: simple
186
+ schema:
187
+ type: string
188
+ responses:
189
+ '200':
190
+ description: successful operation
191
+ headers: {}
192
+ content:
193
+ text/plain:
194
+ schema:
195
+ type: string
196
+ description: successful operation
197
+ deprecated: false
198
+ put:
199
+ tags:
200
+ - MGConnectivityMonitoringDestinations
201
+ summary: updateNetworkCellularGatewaySettingsConnectivityMonitoringDestinations
202
+ description: Update the connectivity testing destinations for an MG network
203
+ operationId: updateNetworkCellularGatewaySettingsConnectivityMonitoringDestinations
204
+ parameters:
205
+ - name: networkId
206
+ in: path
207
+ description: networkId
208
+ required: true
209
+ style: simple
210
+ schema:
211
+ type: string
212
+ requestBody:
213
+ description: body
214
+ content:
215
+ text/plain:
216
+ schema:
217
+ type: string
218
+ description: body
219
+ required: false
220
+ responses:
221
+ '200':
222
+ description: successful operation
223
+ headers: {}
224
+ content:
225
+ text/plain:
226
+ schema:
227
+ type: string
228
+ description: successful operation
229
+ deprecated: false
230
+ /api/v0/networks/{networkId}/cellularGateway/settings/dhcp:
231
+ get:
232
+ tags:
233
+ - MGDHCPSettings
234
+ summary: getNetworkCellularGatewaySettingsDhcp
235
+ description: List common DHCP settings of MGs
236
+ operationId: getNetworkCellularGatewaySettingsDhcp
237
+ parameters:
238
+ - name: networkId
239
+ in: path
240
+ description: networkId
241
+ required: true
242
+ style: simple
243
+ schema:
244
+ type: string
245
+ responses:
246
+ '200':
247
+ description: successful operation
248
+ headers: {}
249
+ content:
250
+ text/plain:
251
+ schema:
252
+ type: string
253
+ description: successful operation
254
+ deprecated: false
255
+ put:
256
+ tags:
257
+ - MGDHCPSettings
258
+ summary: updateNetworkCellularGatewaySettingsDhcp
259
+ description: Update common DHCP settings of MGs
260
+ operationId: updateNetworkCellularGatewaySettingsDhcp
261
+ parameters:
262
+ - name: networkId
263
+ in: path
264
+ description: networkId
265
+ required: true
266
+ style: simple
267
+ schema:
268
+ type: string
269
+ requestBody:
270
+ description: body
271
+ content:
272
+ text/plain:
273
+ schema:
274
+ type: string
275
+ description: body
276
+ required: false
277
+ responses:
278
+ '200':
279
+ description: successful operation
280
+ headers: {}
281
+ content:
282
+ text/plain:
283
+ schema:
284
+ type: string
285
+ description: successful operation
286
+ deprecated: false
287
+ /api/v0/devices/{serial}/cellularGateway/settings:
288
+ get:
289
+ tags:
290
+ - MGLANSettings
291
+ summary: getDeviceCellularGatewaySettings
292
+ description: Show the LAN Settings of a MG
293
+ operationId: getDeviceCellularGatewaySettings
294
+ parameters:
295
+ - name: serial
296
+ in: path
297
+ description: serial
298
+ required: true
299
+ style: simple
300
+ schema:
301
+ type: string
302
+ responses:
303
+ '200':
304
+ description: successful operation
305
+ headers: {}
306
+ content:
307
+ text/plain:
308
+ schema:
309
+ type: string
310
+ description: successful operation
311
+ deprecated: false
312
+ put:
313
+ tags:
314
+ - MGLANSettings
315
+ summary: updateDeviceCellularGatewaySettings
316
+ description: Update the LAN Settings for a single MG.
317
+ operationId: updateDeviceCellularGatewaySettings
318
+ parameters:
319
+ - name: serial
320
+ in: path
321
+ description: serial
322
+ required: true
323
+ style: simple
324
+ schema:
325
+ type: string
326
+ requestBody:
327
+ description: body
328
+ content:
329
+ text/plain:
330
+ schema:
331
+ type: string
332
+ description: body
333
+ required: false
334
+ responses:
335
+ '200':
336
+ description: successful operation
337
+ headers: {}
338
+ content:
339
+ text/plain:
340
+ schema:
341
+ type: string
342
+ description: successful operation
343
+ deprecated: false
344
+ /api/v0/devices/{serial}/cellularGateway/settings/portForwardingRules:
345
+ get:
346
+ tags:
347
+ - MGPortforwardingRules
348
+ summary: getDeviceCellularGatewaySettingsPortForwardingRules
349
+ description: Returns the port forwarding rules for a single MG.
350
+ operationId: getDeviceCellularGatewaySettingsPortForwardingRules
351
+ parameters:
352
+ - name: serial
353
+ in: path
354
+ description: serial
355
+ required: true
356
+ style: simple
357
+ schema:
358
+ type: string
359
+ responses:
360
+ '200':
361
+ description: successful operation
362
+ headers: {}
363
+ content:
364
+ text/plain:
365
+ schema:
366
+ type: string
367
+ description: successful operation
368
+ deprecated: false
369
+ put:
370
+ tags:
371
+ - MGPortforwardingRules
372
+ summary: updateDeviceCellularGatewaySettingsPortForwardingRules
373
+ description: Updates the port forwarding rules for a single MG.
374
+ operationId: updateDeviceCellularGatewaySettingsPortForwardingRules
375
+ parameters:
376
+ - name: serial
377
+ in: path
378
+ description: serial
379
+ required: true
380
+ style: simple
381
+ schema:
382
+ type: string
383
+ requestBody:
384
+ description: body
385
+ content:
386
+ text/plain:
387
+ schema:
388
+ type: string
389
+ description: body
390
+ required: false
391
+ responses:
392
+ '200':
393
+ description: successful operation
394
+ headers: {}
395
+ content:
396
+ text/plain:
397
+ schema:
398
+ type: string
399
+ description: successful operation
400
+ deprecated: false
401
+ /api/v0/networks/{networkId}/cellularGateway/settings/subnetPool:
402
+ get:
403
+ tags:
404
+ - MGSubnetPoolSettings
405
+ summary: getNetworkCellularGatewaySettingsSubnetPool
406
+ description: Return the subnet pool and mask configured for MGs in the network.
407
+ operationId: getNetworkCellularGatewaySettingsSubnetPool
408
+ parameters:
409
+ - name: networkId
410
+ in: path
411
+ description: networkId
412
+ required: true
413
+ style: simple
414
+ schema:
415
+ type: string
416
+ responses:
417
+ '200':
418
+ description: successful operation
419
+ headers: {}
420
+ content:
421
+ text/plain:
422
+ schema:
423
+ type: string
424
+ description: successful operation
425
+ deprecated: false
426
+ put:
427
+ tags:
428
+ - MGSubnetPoolSettings
429
+ summary: updateNetworkCellularGatewaySettingsSubnetPool
430
+ description: Update the subnet pool and mask configuration for MGs in the network.
431
+ operationId: updateNetworkCellularGatewaySettingsSubnetPool
432
+ parameters:
433
+ - name: networkId
434
+ in: path
435
+ description: networkId
436
+ required: true
437
+ style: simple
438
+ schema:
439
+ type: string
440
+ requestBody:
441
+ description: body
442
+ content:
443
+ text/plain:
444
+ schema:
445
+ type: string
446
+ description: body
447
+ required: false
448
+ responses:
449
+ '200':
450
+ description: successful operation
451
+ headers: {}
452
+ content:
453
+ text/plain:
454
+ schema:
455
+ type: string
456
+ description: successful operation
457
+ deprecated: false
458
+ /api/v0/networks/{networkId}/cellularGateway/settings/uplink:
459
+ get:
460
+ tags:
461
+ - MGUplinkSettings
462
+ summary: getNetworkCellularGatewaySettingsUplink
463
+ description: Returns the uplink settings for your MG network.
464
+ operationId: getNetworkCellularGatewaySettingsUplink
465
+ parameters:
466
+ - name: networkId
467
+ in: path
468
+ description: networkId
469
+ required: true
470
+ style: simple
471
+ schema:
472
+ type: string
473
+ responses:
474
+ '200':
475
+ description: successful operation
476
+ headers: {}
477
+ content:
478
+ text/plain:
479
+ schema:
480
+ type: string
481
+ description: successful operation
482
+ deprecated: false
483
+ put:
484
+ tags:
485
+ - MGUplinkSettings
486
+ summary: updateNetworkCellularGatewaySettingsUplink
487
+ description: Updates the uplink settings for your MG network.
488
+ operationId: updateNetworkCellularGatewaySettingsUplink
489
+ parameters:
490
+ - name: networkId
491
+ in: path
492
+ description: networkId
493
+ required: true
494
+ style: simple
495
+ schema:
496
+ type: string
497
+ requestBody:
498
+ description: body
499
+ content:
500
+ text/plain:
501
+ schema:
502
+ type: string
503
+ description: body
504
+ required: false
505
+ responses:
506
+ '200':
507
+ description: successful operation
508
+ headers: {}
509
+ content:
510
+ text/plain:
511
+ schema:
512
+ type: string
513
+ description: successful operation
514
+ deprecated: false
515
+ /api/v0/networks/{networkId}/switch/accessControlLists:
516
+ get:
517
+ tags:
518
+ - SwitchACLs
519
+ summary: getNetworkSwitchAccessControlLists
520
+ description: Return the access control lists for a MS network
521
+ operationId: getNetworkSwitchAccessControlLists
522
+ parameters:
523
+ - name: networkId
524
+ in: path
525
+ description: ''
526
+ required: true
527
+ style: simple
528
+ schema:
529
+ type: string
530
+ responses:
531
+ '200':
532
+ description: successful operation
533
+ headers: {}
534
+ content:
535
+ text/plain:
536
+ schema:
537
+ type: string
538
+ description: successful operation
539
+ deprecated: false
540
+ put:
541
+ tags:
542
+ - SwitchACLs
543
+ summary: updateNetworkSwitchAccessControlLists
544
+ description: Update the access control lists for a MS network
545
+ operationId: updateNetworkSwitchAccessControlLists
546
+ parameters:
547
+ - name: networkId
548
+ in: path
549
+ description: networkId
550
+ required: true
551
+ style: simple
552
+ schema:
553
+ type: string
554
+ requestBody:
555
+ description: body
556
+ content:
557
+ text/plain:
558
+ schema:
559
+ type: string
560
+ description: body
561
+ required: false
562
+ responses:
563
+ '200':
564
+ description: successful operation
565
+ headers: {}
566
+ content:
567
+ text/plain:
568
+ schema:
569
+ type: string
570
+ description: successful operation
571
+ deprecated: false
572
+ /api/v0/networks/{networkId}/switch/portSchedules:
573
+ get:
574
+ tags:
575
+ - SwitchPortsSchedules
576
+ summary: getNetworkSwitchPortSchedules
577
+ description: List switch port schedules
578
+ operationId: getNetworkSwitchPortSchedules
579
+ parameters:
580
+ - name: networkId
581
+ in: path
582
+ description: networkId
583
+ required: true
584
+ style: simple
585
+ schema:
586
+ type: string
587
+ responses:
588
+ '200':
589
+ description: successful operation
590
+ headers: {}
591
+ content:
592
+ text/plain:
593
+ schema:
594
+ type: string
595
+ description: successful operation
596
+ deprecated: false
597
+ post:
598
+ tags:
599
+ - SwitchPortsSchedules
600
+ summary: createNetworkSwitchPortSchedule
601
+ description: Add a switch port schedule
602
+ operationId: createNetworkSwitchPortSchedule
603
+ parameters:
604
+ - name: networkId
605
+ in: path
606
+ description: networkId
607
+ required: true
608
+ style: simple
609
+ schema:
610
+ type: string
611
+ requestBody:
612
+ description: body
613
+ content:
614
+ text/plain:
615
+ schema:
616
+ type: string
617
+ description: body
618
+ required: false
619
+ responses:
620
+ '200':
621
+ description: successful operation
622
+ headers: {}
623
+ content:
624
+ text/plain:
625
+ schema:
626
+ type: string
627
+ description: successful operation
628
+ deprecated: false
629
+ /api/v0/networks/{networkId}/switch/portSchedules/{portScheduleId}:
630
+ put:
631
+ tags:
632
+ - SwitchPortsSchedules
633
+ summary: updateNetworkSwitchPortSchedule
634
+ description: Update the access control lists for a MS network
635
+ operationId: updateNetworkSwitchPortSchedule
636
+ parameters:
637
+ - name: networkId
638
+ in: path
639
+ description: networkId
640
+ required: true
641
+ style: simple
642
+ schema:
643
+ type: string
644
+ - name: portScheduleId
645
+ in: path
646
+ description: portScheduleId
647
+ required: true
648
+ style: simple
649
+ schema:
650
+ type: string
651
+ requestBody:
652
+ description: body
653
+ content:
654
+ text/plain:
655
+ schema:
656
+ type: string
657
+ description: body
658
+ required: false
659
+ responses:
660
+ '200':
661
+ description: successful operation
662
+ headers: {}
663
+ content:
664
+ text/plain:
665
+ schema:
666
+ type: string
667
+ description: successful operation
668
+ deprecated: false
669
+ delete:
670
+ tags:
671
+ - SwitchPortsSchedules
672
+ summary: deleteNetworkSwitchPortSchedule
673
+ description: Delete a switch port schedule
674
+ operationId: deleteNetworkSwitchPortSchedule
675
+ parameters:
676
+ - name: networkId
677
+ in: path
678
+ description: networkId
679
+ required: true
680
+ style: simple
681
+ schema:
682
+ type: string
683
+ - name: portScheduleId
684
+ in: path
685
+ description: portScheduleId
686
+ required: true
687
+ style: simple
688
+ schema:
689
+ type: string
690
+ responses:
691
+ '200':
692
+ description: successful operation
693
+ headers: {}
694
+ content:
695
+ text/plain:
696
+ schema:
697
+ type: string
698
+ description: successful operation
699
+ deprecated: false
700
+ /api/v0/networks/{networkId}/appliancePorts:
701
+ get:
702
+ tags:
703
+ - MXVLANPorts
704
+ summary: getNetworkAppliancePorts
705
+ description: List per-port VLAN settings for all ports of a MX.
706
+ operationId: getNetworkAppliancePorts
707
+ parameters:
708
+ - name: networkId
709
+ in: path
710
+ description: networkId
711
+ required: true
712
+ style: simple
713
+ schema:
714
+ type: string
715
+ responses:
716
+ '200':
717
+ description: successful operation
718
+ headers: {}
719
+ content:
720
+ text/plain:
721
+ schema:
722
+ type: string
723
+ description: successful operation
724
+ deprecated: false
725
+ /api/v0/networks/{networkId}/appliancePorts/{appliancePortId}:
726
+ get:
727
+ tags:
728
+ - MXVLANPorts
729
+ summary: getNetworkAppliancePort
730
+ description: Return per-port VLAN settings for a single MX port.
731
+ operationId: getNetworkAppliancePort
732
+ parameters:
733
+ - name: networkId
734
+ in: path
735
+ description: networkId
736
+ required: true
737
+ style: simple
738
+ schema:
739
+ type: string
740
+ - name: appliancePortId
741
+ in: path
742
+ description: appliancePortId
743
+ required: true
744
+ style: simple
745
+ schema:
746
+ type: string
747
+ responses:
748
+ '200':
749
+ description: successful operation
750
+ headers: {}
751
+ content:
752
+ text/plain:
753
+ schema:
754
+ type: string
755
+ description: successful operation
756
+ deprecated: false
757
+ put:
758
+ tags:
759
+ - MXVLANPorts
760
+ summary: updateNetworkAppliancePort
761
+ description: Update the per-port VLAN settings for a single MX port.
762
+ operationId: updateNetworkAppliancePort
763
+ parameters:
764
+ - name: networkId
765
+ in: path
766
+ description: networkId
767
+ required: true
768
+ style: simple
769
+ schema:
770
+ type: string
771
+ - name: appliancePortId
772
+ in: path
773
+ description: appliancePortId
774
+ required: true
775
+ style: simple
776
+ schema:
777
+ type: string
778
+ requestBody:
779
+ description: body
780
+ content:
781
+ text/plain:
782
+ schema:
783
+ type: string
784
+ description: body
785
+ required: false
786
+ responses:
787
+ '200':
788
+ description: successful operation
789
+ headers: {}
790
+ content:
791
+ text/plain:
792
+ schema:
793
+ type: string
794
+ description: successful operation
795
+ deprecated: false
796
+ /api/v0/networks/{networkId}/swapWarmSpare:
797
+ post:
798
+ tags:
799
+ - MXWarmSpareSettings
800
+ summary: swapNetworkWarmspare
801
+ description: Swap MX primary and warm spare appliances
802
+ operationId: swapNetworkWarmspare
803
+ parameters:
804
+ - name: networkId
805
+ in: path
806
+ description: networkId
807
+ required: true
808
+ style: simple
809
+ schema:
810
+ type: string
811
+ requestBody:
812
+ description: body
813
+ content:
814
+ text/plain:
815
+ schema:
816
+ type: string
817
+ description: body
818
+ required: false
819
+ responses:
820
+ '200':
821
+ description: successful operation
822
+ headers: {}
823
+ content:
824
+ text/plain:
825
+ schema:
826
+ type: string
827
+ description: successful operation
828
+ deprecated: false
829
+ /api/v0/networks/{networkId}/warmSpareSettings:
830
+ get:
831
+ tags:
832
+ - MXWarmSpareSettings
833
+ summary: getNetworkWarmSpareSettings
834
+ description: Return MX warm spare settings
835
+ operationId: getNetworkWarmSpareSettings
836
+ parameters:
837
+ - name: networkId
838
+ in: path
839
+ description: networkId
840
+ required: true
841
+ style: simple
842
+ schema:
843
+ type: string
844
+ responses:
845
+ '200':
846
+ description: successful operation
847
+ headers: {}
848
+ content:
849
+ text/plain:
850
+ schema:
851
+ type: string
852
+ description: successful operation
853
+ deprecated: false
854
+ put:
855
+ tags:
856
+ - MXWarmSpareSettings
857
+ summary: updateNetworkWarmSpareSettings
858
+ description: Update MX warm spare settings
859
+ operationId: updateNetworkWarmSpareSettings
860
+ parameters:
861
+ - name: networkId
862
+ in: path
863
+ description: networkId
864
+ required: true
865
+ style: simple
866
+ schema:
867
+ type: string
868
+ requestBody:
869
+ description: body
870
+ content:
871
+ text/plain:
872
+ schema:
873
+ type: string
874
+ description: body
875
+ required: false
876
+ responses:
877
+ '200':
878
+ description: successful operation
879
+ headers: {}
880
+ content:
881
+ text/plain:
882
+ schema:
883
+ type: string
884
+ description: successful operation
885
+ deprecated: false
886
+ /api/v0/organizations/{organizationId}/licenses:
887
+ get:
888
+ tags:
889
+ - Licenses
890
+ summary: getOrganizationLicenses
891
+ description: List the licenses for an organization
892
+ operationId: getOrganizationLicenses
893
+ parameters:
894
+ - name: perPage
895
+ in: query
896
+ description: ''
897
+ style: form
898
+ explode: true
899
+ schema:
900
+ type: number
901
+ format: double
902
+ - name: startingAfter
903
+ in: query
904
+ description: ''
905
+ style: form
906
+ explode: true
907
+ schema:
908
+ type: number
909
+ format: double
910
+ - name: endingBefore
911
+ in: query
912
+ description: ''
913
+ style: form
914
+ explode: true
915
+ schema:
916
+ type: number
917
+ format: double
918
+ - name: deviceSerial
919
+ in: query
920
+ description: ''
921
+ style: form
922
+ explode: true
923
+ schema:
924
+ type: string
925
+ - name: networkId
926
+ in: query
927
+ description: ''
928
+ style: form
929
+ explode: true
930
+ schema:
931
+ type: string
932
+ - name: state
933
+ in: query
934
+ description: ''
935
+ style: form
936
+ explode: true
937
+ schema:
938
+ type: string
939
+ - name: organizationId
940
+ in: path
941
+ description: organizationId
942
+ required: true
943
+ style: simple
944
+ schema:
945
+ type: string
946
+ responses:
947
+ '200':
948
+ description: successful operation
949
+ headers: {}
950
+ content:
951
+ text/plain:
952
+ schema:
953
+ type: string
954
+ description: successful operation
955
+ deprecated: false
956
+ /api/v0/organizations/{organizationId}/licenses/{licenseId}:
957
+ get:
958
+ tags:
959
+ - Licenses
960
+ summary: getOrganizationLicense
961
+ description: Display a license
962
+ operationId: getOrganizationLicense
963
+ parameters:
964
+ - name: organizationId
965
+ in: path
966
+ description: ''
967
+ required: true
968
+ style: simple
969
+ schema:
970
+ type: string
971
+ - name: licenseId
972
+ in: path
973
+ description: ''
974
+ required: true
975
+ style: simple
976
+ schema:
977
+ type: string
978
+ responses:
979
+ '200':
980
+ description: successful operation
981
+ headers: {}
982
+ content:
983
+ text/plain:
984
+ schema:
985
+ type: string
986
+ description: successful operation
987
+ deprecated: false
988
+ put:
989
+ tags:
990
+ - Licenses
991
+ summary: updateOrganizationLicense
992
+ description: Update a license
993
+ operationId: updateOrganizationLicense
994
+ parameters:
995
+ - name: organizationId
996
+ in: path
997
+ description: organizationId
998
+ required: true
999
+ style: simple
1000
+ schema:
1001
+ type: string
1002
+ - name: licenseId
1003
+ in: path
1004
+ description: licenseId
1005
+ required: true
1006
+ style: simple
1007
+ schema:
1008
+ type: string
1009
+ requestBody:
1010
+ description: body
1011
+ content:
1012
+ text/plain:
1013
+ schema:
1014
+ type: string
1015
+ description: body
1016
+ required: false
1017
+ responses:
1018
+ '200':
1019
+ description: successful operation
1020
+ headers: {}
1021
+ content:
1022
+ text/plain:
1023
+ schema:
1024
+ type: string
1025
+ description: successful operation
1026
+ deprecated: false
1027
+ /api/v0/organizations/{organizationId}/licenses/assignSeats:
1028
+ post:
1029
+ tags:
1030
+ - Licenses
1031
+ summary: assignOrganizationLicensesSeats
1032
+ description: Assign SM seats to a network.
1033
+ operationId: assignOrganizationLicensesSeats
1034
+ parameters:
1035
+ - name: organizationId
1036
+ in: path
1037
+ description: organizationId
1038
+ required: true
1039
+ style: simple
1040
+ schema:
1041
+ type: string
1042
+ requestBody:
1043
+ description: body
1044
+ content:
1045
+ text/plain:
1046
+ schema:
1047
+ type: string
1048
+ description: body
1049
+ required: false
1050
+ responses:
1051
+ '200':
1052
+ description: successful operation
1053
+ headers: {}
1054
+ content:
1055
+ text/plain:
1056
+ schema:
1057
+ type: string
1058
+ description: successful operation
1059
+ deprecated: false
1060
+ /api/v0/organizations/{organizationId}/licenses/move:
1061
+ post:
1062
+ tags:
1063
+ - Licenses
1064
+ summary: moveOrganizationLicenses
1065
+ description: Move licenses to another organization.
1066
+ operationId: moveOrganizationLicenses
1067
+ parameters:
1068
+ - name: organizationId
1069
+ in: path
1070
+ description: organizationId
1071
+ required: true
1072
+ style: simple
1073
+ schema:
1074
+ type: string
1075
+ requestBody:
1076
+ description: body
1077
+ content:
1078
+ text/plain:
1079
+ schema:
1080
+ type: string
1081
+ description: body
1082
+ required: false
1083
+ responses:
1084
+ '200':
1085
+ description: successful operation
1086
+ headers: {}
1087
+ content:
1088
+ text/plain:
1089
+ schema:
1090
+ type: string
1091
+ description: successful operation
1092
+ deprecated: false
1093
+ /api/v0/organizations/{organizationId}/licenses/moveSeats:
1094
+ post:
1095
+ tags:
1096
+ - Licenses
1097
+ summary: moveOrganizationLicensesSeats
1098
+ description: Move SM seats to another organization
1099
+ operationId: moveOrganizationLicensesSeats
1100
+ parameters:
1101
+ - name: organizationId
1102
+ in: path
1103
+ description: organizationId
1104
+ required: true
1105
+ style: simple
1106
+ schema:
1107
+ type: string
1108
+ requestBody:
1109
+ description: body
1110
+ content:
1111
+ text/plain:
1112
+ schema:
1113
+ type: string
1114
+ description: body
1115
+ required: false
1116
+ responses:
1117
+ '200':
1118
+ description: successful operation
1119
+ headers: {}
1120
+ content:
1121
+ text/plain:
1122
+ schema:
1123
+ type: string
1124
+ description: successful operation
1125
+ deprecated: false
1126
+ /api/v0/organizations/{organizationId}/licenses/renewSeats:
1127
+ post:
1128
+ tags:
1129
+ - Licenses
1130
+ summary: renewOrganizationLicensesSeats
1131
+ description: Renew SM seats of a license.
1132
+ operationId: renewOrganizationLicensesSeats
1133
+ parameters:
1134
+ - name: organizationId
1135
+ in: path
1136
+ description: organizationId
1137
+ required: true
1138
+ style: simple
1139
+ schema:
1140
+ type: string
1141
+ requestBody:
1142
+ description: body
1143
+ content:
1144
+ text/plain:
1145
+ schema:
1146
+ type: string
1147
+ description: body
1148
+ required: false
1149
+ responses:
1150
+ '200':
1151
+ description: successful operation
1152
+ headers: {}
1153
+ content:
1154
+ text/plain:
1155
+ schema:
1156
+ type: string
1157
+ description: successful operation
1158
+ deprecated: false
1159
+ /api/v0/networks/{networkId}/switch/settings:
1160
+ get:
1161
+ tags:
1162
+ - SwitchSettings
1163
+ summary: getNetworkSwitchSettings
1164
+ description: Returns the switch network settings
1165
+ operationId: getNetworkSwitchSettings
1166
+ parameters:
1167
+ - name: networkId
1168
+ in: path
1169
+ description: ''
1170
+ required: true
1171
+ style: simple
1172
+ schema:
1173
+ type: string
1174
+ responses:
1175
+ '200':
1176
+ description: successful operation
1177
+ headers: {}
1178
+ content:
1179
+ text/plain:
1180
+ schema:
1181
+ type: string
1182
+ description: successful operation
1183
+ deprecated: false
1184
+ put:
1185
+ tags:
1186
+ - SwitchSettings
1187
+ summary: updateNetworkSwitchSettings
1188
+ description: Update switch network settings
1189
+ operationId: updateNetworkSwitchSettings
1190
+ parameters:
1191
+ - name: networkId
1192
+ in: path
1193
+ description: networkId
1194
+ required: true
1195
+ style: simple
1196
+ schema:
1197
+ type: string
1198
+ requestBody:
1199
+ description: body
1200
+ content:
1201
+ text/plain:
1202
+ schema:
1203
+ type: string
1204
+ description: body
1205
+ required: false
1206
+ responses:
1207
+ '200':
1208
+ description: successful operation
1209
+ headers: {}
1210
+ content:
1211
+ text/plain:
1212
+ schema:
1213
+ type: string
1214
+ description: successful operation
1215
+ deprecated: false
1216
+ /api/v0/networks/{networkId}/switch/settings/dhcpServerPolicy:
1217
+ get:
1218
+ tags:
1219
+ - SwitchSettings
1220
+ summary: getNetworkSwitchSettingsDhcpServerPolicy
1221
+ description: Return the DHCP server policy
1222
+ operationId: getNetworkSwitchSettingsDhcpServerPolicy
1223
+ parameters:
1224
+ - name: networkId
1225
+ in: path
1226
+ description: ''
1227
+ required: true
1228
+ style: simple
1229
+ schema:
1230
+ type: string
1231
+ responses:
1232
+ '200':
1233
+ description: successful operation
1234
+ headers: {}
1235
+ content:
1236
+ text/plain:
1237
+ schema:
1238
+ type: string
1239
+ description: successful operation
1240
+ deprecated: false
1241
+ put:
1242
+ tags:
1243
+ - SwitchSettings
1244
+ summary: updateNetworkSwitchSettingsDhcpServerPolicy
1245
+ description: Update the DHCP server policy
1246
+ operationId: updateNetworkSwitchSettingsDhcpServerPolicy
1247
+ parameters:
1248
+ - name: networkId
1249
+ in: path
1250
+ description: networkId
1251
+ required: true
1252
+ style: simple
1253
+ schema:
1254
+ type: string
1255
+ requestBody:
1256
+ description: body
1257
+ content:
1258
+ text/plain:
1259
+ schema:
1260
+ type: string
1261
+ description: body
1262
+ required: false
1263
+ responses:
1264
+ '200':
1265
+ description: successful operation
1266
+ headers: {}
1267
+ content:
1268
+ text/plain:
1269
+ schema:
1270
+ type: string
1271
+ description: successful operation
1272
+ deprecated: false
1273
+ /api/v0/networks/{networkId}/switch/settings/dscpToCosMappings:
1274
+ get:
1275
+ tags:
1276
+ - SwitchSettings
1277
+ summary: getNetworkSwitchSettingsDscpToCosMappings
1278
+ description: Return the DSCP to CoS mappings
1279
+ operationId: getNetworkSwitchSettingsDscpToCosMappings
1280
+ parameters:
1281
+ - name: networkId
1282
+ in: path
1283
+ description: ''
1284
+ required: true
1285
+ style: simple
1286
+ schema:
1287
+ type: string
1288
+ responses:
1289
+ '200':
1290
+ description: successful operation
1291
+ headers: {}
1292
+ content:
1293
+ text/plain:
1294
+ schema:
1295
+ type: string
1296
+ description: successful operation
1297
+ deprecated: false
1298
+ put:
1299
+ tags:
1300
+ - SwitchSettings
1301
+ summary: updateNetworkSwitchSettingsDscpToCosMappings
1302
+ description: Update the DSCP to CoS mappings
1303
+ operationId: updateNetworkSwitchSettingsDscpToCosMappings
1304
+ parameters:
1305
+ - name: networkId
1306
+ in: path
1307
+ description: networkId
1308
+ required: true
1309
+ style: simple
1310
+ schema:
1311
+ type: string
1312
+ requestBody:
1313
+ description: body
1314
+ content:
1315
+ text/plain:
1316
+ schema:
1317
+ type: string
1318
+ description: body
1319
+ required: false
1320
+ responses:
1321
+ '200':
1322
+ description: successful operation
1323
+ headers: {}
1324
+ content:
1325
+ text/plain:
1326
+ schema:
1327
+ type: string
1328
+ description: successful operation
1329
+ deprecated: false
1330
+ /api/v0/networks/{networkId}/switch/settings/mtu:
1331
+ get:
1332
+ tags:
1333
+ - SwitchSettings
1334
+ summary: getNetworkSwitchSettingsMtu
1335
+ description: Return the MTU configuration
1336
+ operationId: getNetworkSwitchSettingsMtu
1337
+ parameters:
1338
+ - name: networkId
1339
+ in: path
1340
+ description: ''
1341
+ required: true
1342
+ style: simple
1343
+ schema:
1344
+ type: string
1345
+ responses:
1346
+ '200':
1347
+ description: successful operation
1348
+ headers: {}
1349
+ content:
1350
+ text/plain:
1351
+ schema:
1352
+ type: string
1353
+ description: successful operation
1354
+ deprecated: false
1355
+ put:
1356
+ tags:
1357
+ - SwitchSettings
1358
+ summary: updateNetworkSwitchSettingsMtu
1359
+ description: Update the MTU configuration
1360
+ operationId: updateNetworkSwitchSettingsMtu
1361
+ parameters:
1362
+ - name: networkId
1363
+ in: path
1364
+ description: networkId
1365
+ required: true
1366
+ style: simple
1367
+ schema:
1368
+ type: string
1369
+ requestBody:
1370
+ description: body
1371
+ content:
1372
+ text/plain:
1373
+ schema:
1374
+ type: string
1375
+ description: body
1376
+ required: false
1377
+ responses:
1378
+ '200':
1379
+ description: successful operation
1380
+ headers: {}
1381
+ content:
1382
+ text/plain:
1383
+ schema:
1384
+ type: string
1385
+ description: successful operation
1386
+ deprecated: false
1387
+ /api/v0/networks/{networkId}/switch/settings/qosRules:
1388
+ get:
1389
+ tags:
1390
+ - SwitchSettings
1391
+ summary: getNetworkSwitchSettingsQosRules
1392
+ description: List quality of service rules
1393
+ operationId: getNetworkSwitchSettingsQosRules
1394
+ parameters:
1395
+ - name: networkId
1396
+ in: path
1397
+ description: ''
1398
+ required: true
1399
+ style: simple
1400
+ schema:
1401
+ type: string
1402
+ responses:
1403
+ '200':
1404
+ description: successful operation
1405
+ headers: {}
1406
+ content:
1407
+ text/plain:
1408
+ schema:
1409
+ type: string
1410
+ description: successful operation
1411
+ deprecated: false
1412
+ post:
1413
+ tags:
1414
+ - SwitchSettings
1415
+ summary: createNetworkSwitchSettingsQosRule
1416
+ description: Add a quality of service rule
1417
+ operationId: createNetworkSwitchSettingsQosRule
1418
+ parameters:
1419
+ - name: networkId
1420
+ in: path
1421
+ description: ''
1422
+ required: true
1423
+ style: simple
1424
+ schema:
1425
+ type: string
1426
+ requestBody:
1427
+ description: ''
1428
+ content:
1429
+ text/plain:
1430
+ schema:
1431
+ type: string
1432
+ required: false
1433
+ responses:
1434
+ '200':
1435
+ description: successful operation
1436
+ headers: {}
1437
+ content:
1438
+ text/plain:
1439
+ schema:
1440
+ type: string
1441
+ description: successful operation
1442
+ deprecated: false
1443
+ /api/v0/networks/{networkId}/switch/settings/qosRules/order:
1444
+ get:
1445
+ tags:
1446
+ - SwitchSettings
1447
+ summary: getNetworkSwitchSettingsQosRulesOrder
1448
+ description: Return the quality of service rule IDs by order in which they will be processed by the switch
1449
+ operationId: getNetworkSwitchSettingsQosRulesOrder
1450
+ parameters:
1451
+ - name: networkId
1452
+ in: path
1453
+ description: ''
1454
+ required: true
1455
+ style: simple
1456
+ schema:
1457
+ type: string
1458
+ responses:
1459
+ '200':
1460
+ description: successful operation
1461
+ headers: {}
1462
+ content:
1463
+ text/plain:
1464
+ schema:
1465
+ type: string
1466
+ description: successful operation
1467
+ deprecated: false
1468
+ put:
1469
+ tags:
1470
+ - SwitchSettings
1471
+ summary: updateNetworkSwitchSettingsQosRulesOrder
1472
+ description: Update the order in which the rules should be processed by the switch
1473
+ operationId: updateNetworkSwitchSettingsQosRulesOrder
1474
+ parameters:
1475
+ - name: networkId
1476
+ in: path
1477
+ description: networkId
1478
+ required: true
1479
+ style: simple
1480
+ schema:
1481
+ type: string
1482
+ requestBody:
1483
+ description: body
1484
+ content:
1485
+ text/plain:
1486
+ schema:
1487
+ type: string
1488
+ description: body
1489
+ required: false
1490
+ responses:
1491
+ '200':
1492
+ description: successful operation
1493
+ headers: {}
1494
+ content:
1495
+ text/plain:
1496
+ schema:
1497
+ type: string
1498
+ description: successful operation
1499
+ deprecated: false
1500
+ /api/v0/networks/{networkId}/switch/settings/qosRules/:
1501
+ get:
1502
+ tags:
1503
+ - SwitchSettings
1504
+ summary: getNetworkSwitchSettingsQosRule
1505
+ description: Return a quality of service rule
1506
+ operationId: getNetworkSwitchSettingsQosRule
1507
+ parameters:
1508
+ - name: networkId
1509
+ in: path
1510
+ description: ''
1511
+ required: true
1512
+ style: simple
1513
+ schema:
1514
+ type: string
1515
+ responses:
1516
+ '200':
1517
+ description: successful operation
1518
+ headers: {}
1519
+ content:
1520
+ text/plain:
1521
+ schema:
1522
+ type: string
1523
+ description: successful operation
1524
+ deprecated: false
1525
+ /api/v0/networks/{networkId}/switch/settings/qosRules/{qosRuleId}:
1526
+ delete:
1527
+ tags:
1528
+ - SwitchSettings
1529
+ summary: deleteNetworkSwitchSettingsQosRule
1530
+ description: Delete a quality of service rule
1531
+ operationId: deleteNetworkSwitchSettingsQosRule
1532
+ parameters:
1533
+ - name: networkId
1534
+ in: path
1535
+ description: networkId
1536
+ required: true
1537
+ style: simple
1538
+ schema:
1539
+ type: string
1540
+ - name: qosRuleId
1541
+ in: path
1542
+ description: qosRuleId
1543
+ required: true
1544
+ style: simple
1545
+ schema:
1546
+ type: string
1547
+ responses:
1548
+ '200':
1549
+ description: successful operation
1550
+ headers: {}
1551
+ content:
1552
+ text/plain:
1553
+ schema:
1554
+ type: string
1555
+ description: successful operation
1556
+ deprecated: false
1557
+ put:
1558
+ tags:
1559
+ - SwitchSettings
1560
+ summary: updateNetworkSwitchSettingsQosRule
1561
+ description: Update a quality of service rule
1562
+ operationId: updateNetworkSwitchSettingsQosRule
1563
+ parameters:
1564
+ - name: networkId
1565
+ in: path
1566
+ description: networkId
1567
+ required: true
1568
+ style: simple
1569
+ schema:
1570
+ type: string
1571
+ - name: qosRuleId
1572
+ in: path
1573
+ description: qosRuleId
1574
+ required: true
1575
+ style: simple
1576
+ schema:
1577
+ type: string
1578
+ requestBody:
1579
+ description: body
1580
+ content:
1581
+ text/plain:
1582
+ schema:
1583
+ type: string
1584
+ description: body
1585
+ required: false
1586
+ responses:
1587
+ '200':
1588
+ description: successful operation
1589
+ headers: {}
1590
+ content:
1591
+ text/plain:
1592
+ schema:
1593
+ type: string
1594
+ description: successful operation
1595
+ deprecated: false
1596
+ /api/v0/networks/{networkId}/switch/settings/stormControl:
1597
+ get:
1598
+ tags:
1599
+ - SwitchSettings
1600
+ summary: getNetworkSwitchSettingsStormControl
1601
+ description: Return the storm control configuration for a switch network
1602
+ operationId: getNetworkSwitchSettingsStormControl
1603
+ parameters:
1604
+ - name: networkId
1605
+ in: path
1606
+ description: ''
1607
+ required: true
1608
+ style: simple
1609
+ schema:
1610
+ type: string
1611
+ responses:
1612
+ '200':
1613
+ description: successful operation
1614
+ headers: {}
1615
+ content:
1616
+ text/plain:
1617
+ schema:
1618
+ type: string
1619
+ description: successful operation
1620
+ deprecated: false
1621
+ put:
1622
+ tags:
1623
+ - SwitchSettings
1624
+ summary: updateNetworkSwitchSettingsStormControl
1625
+ description: Update the storm control configuration for a switch network
1626
+ operationId: updateNetworkSwitchSettingsStormControl
1627
+ parameters:
1628
+ - name: networkId
1629
+ in: path
1630
+ description: networkId
1631
+ required: true
1632
+ style: simple
1633
+ schema:
1634
+ type: string
1635
+ requestBody:
1636
+ description: body
1637
+ content:
1638
+ text/plain:
1639
+ schema:
1640
+ type: string
1641
+ description: body
1642
+ required: false
1643
+ responses:
1644
+ '200':
1645
+ description: successful operation
1646
+ headers: {}
1647
+ content:
1648
+ text/plain:
1649
+ schema:
1650
+ type: string
1651
+ description: successful operation
1652
+ deprecated: false
1653
+ /api/v0/networks/{networkId}/switch/settings/stp:
1654
+ get:
1655
+ tags:
1656
+ - SwitchSettings
1657
+ summary: getNetworkSwitchSettingsStp
1658
+ description: Returns STP settings
1659
+ operationId: getNetworkSwitchSettingsStp
1660
+ parameters:
1661
+ - name: networkId
1662
+ in: path
1663
+ description: ''
1664
+ required: true
1665
+ style: simple
1666
+ schema:
1667
+ type: string
1668
+ responses:
1669
+ '200':
1670
+ description: successful operation
1671
+ headers: {}
1672
+ content:
1673
+ text/plain:
1674
+ schema:
1675
+ type: string
1676
+ description: successful operation
1677
+ deprecated: false
1678
+ put:
1679
+ tags:
1680
+ - SwitchSettings
1681
+ summary: updateNetworkSwitchSettingsStp
1682
+ description: Updates STP settings
1683
+ operationId: updateNetworkSwitchSettingsStp
1684
+ parameters:
1685
+ - name: networkId
1686
+ in: path
1687
+ description: networkId
1688
+ required: true
1689
+ style: simple
1690
+ schema:
1691
+ type: string
1692
+ requestBody:
1693
+ description: body
1694
+ content:
1695
+ text/plain:
1696
+ schema:
1697
+ type: string
1698
+ description: body
1699
+ required: false
1700
+ responses:
1701
+ '200':
1702
+ description: successful operation
1703
+ headers: {}
1704
+ content:
1705
+ text/plain:
1706
+ schema:
1707
+ type: string
1708
+ description: successful operation
1709
+ deprecated: false
1710
+ /api/v0/networks/{networkId}/connectivityMonitoringDestinations:
1711
+ get:
1712
+ tags:
1713
+ - ConnectivityMonitoringDestinations
1714
+ summary: getNetworkConnectivityMonitoringDestinations
1715
+ description: Return the connectivity testing destinations for an MX network
1716
+ operationId: getNetworkConnectivityMonitoringDestinations
1717
+ parameters:
1718
+ - name: networkId
1719
+ in: path
1720
+ description: networkId
1721
+ required: true
1722
+ style: simple
1723
+ schema:
1724
+ type: string
1725
+ responses:
1726
+ '200':
1727
+ description: successful operation
1728
+ headers: {}
1729
+ content:
1730
+ application/json:
1731
+ schema:
1732
+ $ref: '#/components/schemas/getNetworkConnectivityMonitoringDestinationsResponse'
1733
+ deprecated: false
1734
+ put:
1735
+ tags:
1736
+ - ConnectivityMonitoringDestinations
1737
+ summary: updateNetworkConnectivityMonitoringDestinations
1738
+ description: Update the connectivity testing destinations for an MX network
1739
+ operationId: updateNetworkConnectivityMonitoringDestinations
1740
+ parameters:
1741
+ - name: networkId
1742
+ in: path
1743
+ description: networkId
1744
+ required: true
1745
+ style: simple
1746
+ schema:
1747
+ type: string
1748
+ requestBody:
1749
+ description: body
1750
+ content:
1751
+ text/plain:
1752
+ schema:
1753
+ type: string
1754
+ description: body
1755
+ required: false
1756
+ responses:
1757
+ '200':
1758
+ description: successful operation
1759
+ headers: {}
1760
+ content:
1761
+ text/plain:
1762
+ schema:
1763
+ type: string
1764
+ description: successful operation
1765
+ deprecated: false
1766
+ /api/v0/organizations/{organizationId}/brandingPolicies:
1767
+ get:
1768
+ tags:
1769
+ - DashboardBrandingPolicies
1770
+ summary: getOrganizationBrandingPolicies
1771
+ description: List the branding policies of an organization
1772
+ operationId: getOrganizationBrandingPolicies
1773
+ parameters:
1774
+ - name: organizationId
1775
+ in: path
1776
+ description: organizationId
1777
+ required: true
1778
+ style: simple
1779
+ schema:
1780
+ type: string
1781
+ responses:
1782
+ '200':
1783
+ description: successful operation
1784
+ headers: {}
1785
+ content:
1786
+ application/json:
1787
+ schema:
1788
+ minItems: 1
1789
+ uniqueItems: true
1790
+ type: array
1791
+ items:
1792
+ $ref: '#/components/schemas/getOrganizationBrandingPoliciesResponse'
1793
+ description: successful operation
1794
+ deprecated: false
1795
+ post:
1796
+ tags:
1797
+ - DashboardBrandingPolicies
1798
+ summary: createOrganizationBrandingPolicy
1799
+ description: Add a new branding policy to an organization
1800
+ operationId: createOrganizationBrandingPolicy
1801
+ parameters:
1802
+ - name: organizationId
1803
+ in: path
1804
+ description: organizationId
1805
+ required: true
1806
+ style: simple
1807
+ schema:
1808
+ type: string
1809
+ requestBody:
1810
+ description: body
1811
+ content:
1812
+ text/plain:
1813
+ schema:
1814
+ type: string
1815
+ description: body
1816
+ required: false
1817
+ responses:
1818
+ '200':
1819
+ description: successful operation
1820
+ headers: {}
1821
+ content:
1822
+ application/json:
1823
+ schema:
1824
+ $ref: '#/components/schemas/createOrganizationBrandingPolicyResponse'
1825
+ deprecated: false
1826
+ /api/v0/organizations/{organizationId}/brandingPolicies/priorities:
1827
+ get:
1828
+ tags:
1829
+ - DashboardBrandingPolicies
1830
+ summary: getOrganizationBrandingPoliciesPriorities
1831
+ description: Return the branding policy IDs of an organization in priority order.
1832
+ operationId: getOrganizationBrandingPoliciesPriorities
1833
+ parameters:
1834
+ - name: organizationId
1835
+ in: path
1836
+ description: organizationId
1837
+ required: true
1838
+ style: simple
1839
+ schema:
1840
+ type: string
1841
+ responses:
1842
+ '200':
1843
+ description: successful operation
1844
+ headers: {}
1845
+ content:
1846
+ application/json:
1847
+ schema:
1848
+ $ref: '#/components/schemas/getOrganizationBrandingPoliciesPrioritiesResponse'
1849
+ deprecated: false
1850
+ put:
1851
+ tags:
1852
+ - DashboardBrandingPolicies
1853
+ summary: updateOrganizationBrandingPoliciesPriorities
1854
+ description: Update the priority ordering of an organization's branding policies.
1855
+ operationId: updateOrganizationBrandingPoliciesPriorities
1856
+ parameters:
1857
+ - name: organizationId
1858
+ in: path
1859
+ description: organizationId
1860
+ required: true
1861
+ style: simple
1862
+ schema:
1863
+ type: string
1864
+ requestBody:
1865
+ description: body
1866
+ content:
1867
+ text/plain:
1868
+ schema:
1869
+ type: string
1870
+ description: body
1871
+ required: false
1872
+ responses:
1873
+ '200':
1874
+ description: successful operation
1875
+ headers: {}
1876
+ content:
1877
+ application/json:
1878
+ schema:
1879
+ $ref: '#/components/schemas/updateOrganizationBrandingPoliciesPrioritiesResponse'
1880
+ deprecated: false
1881
+ /api/v0/organizations/{organizationId}/brandingPolicies/:brandingPolicyId:
1882
+ get:
1883
+ tags:
1884
+ - DashboardBrandingPolicies
1885
+ summary: getOrganizationBrandingPolicy
1886
+ description: Return a branding policy
1887
+ operationId: getOrganizationBrandingPolicy
1888
+ parameters:
1889
+ - name: organizationId
1890
+ in: path
1891
+ description: organizationId
1892
+ required: true
1893
+ style: simple
1894
+ schema:
1895
+ type: string
1896
+ responses:
1897
+ '200':
1898
+ description: successful operation
1899
+ headers: {}
1900
+ content:
1901
+ application/json:
1902
+ schema:
1903
+ $ref: '#/components/schemas/getOrganizationBrandingPolicyResponse'
1904
+ deprecated: false
1905
+ /api/v0/organizations/{organizationId}/brandingPolicies/{brandingPolicyId}:
1906
+ put:
1907
+ tags:
1908
+ - DashboardBrandingPolicies
1909
+ summary: updateOrganizationBrandingPolicy
1910
+ description: Update a branding policy
1911
+ operationId: updateOrganizationBrandingPolicy
1912
+ parameters:
1913
+ - name: organizationId
1914
+ in: path
1915
+ description: organizationId
1916
+ required: true
1917
+ style: simple
1918
+ schema:
1919
+ type: string
1920
+ - name: brandingPolicyId
1921
+ in: path
1922
+ description: brandingPolicyId
1923
+ required: true
1924
+ style: simple
1925
+ schema:
1926
+ type: string
1927
+ requestBody:
1928
+ description: body
1929
+ content:
1930
+ text/plain:
1931
+ schema:
1932
+ type: string
1933
+ description: body
1934
+ required: false
1935
+ responses:
1936
+ '200':
1937
+ description: successful operation
1938
+ headers: {}
1939
+ content:
1940
+ application/json:
1941
+ schema:
1942
+ $ref: '#/components/schemas/updateOrganizationBrandingPolicyResponse'
1943
+ deprecated: false
1944
+ delete:
1945
+ tags:
1946
+ - DashboardBrandingPolicies
1947
+ summary: deleteOrganizationBrandingPolicy
1948
+ description: Delete a branding policy
1949
+ operationId: deleteOrganizationBrandingPolicy
1950
+ parameters:
1951
+ - name: organizationId
1952
+ in: path
1953
+ description: organizationId
1954
+ required: true
1955
+ style: simple
1956
+ schema:
1957
+ type: string
1958
+ - name: brandingPolicyId
1959
+ in: path
1960
+ description: brandingPolicyId
1961
+ required: true
1962
+ style: simple
1963
+ schema:
1964
+ type: string
1965
+ responses:
1966
+ '200':
1967
+ description: successful operation
1968
+ headers: {}
1969
+ content:
1970
+ text/plain:
1971
+ schema:
1972
+ type: string
1973
+ description: successful operation
1974
+ deprecated: false
1975
+ /api/v0/networks/{networkId}/events:
1976
+ get:
1977
+ tags:
1978
+ - Events
1979
+ summary: getNetworkEvents
1980
+ description: List the events for the network
1981
+ operationId: getNetworkEvents
1982
+ parameters:
1983
+ - name: productType
1984
+ in: query
1985
+ description: ''
1986
+ style: form
1987
+ explode: true
1988
+ schema:
1989
+ type: number
1990
+ format: double
1991
+ - name: includedEventTypes
1992
+ in: query
1993
+ description: ''
1994
+ style: form
1995
+ explode: true
1996
+ schema:
1997
+ type: array
1998
+ items:
1999
+ type: number
2000
+ format: double
2001
+ - name: excludedEventTypes
2002
+ in: query
2003
+ description: ''
2004
+ style: form
2005
+ explode: true
2006
+ schema:
2007
+ type: array
2008
+ items:
2009
+ type: number
2010
+ format: double
2011
+ - name: deviceMac
2012
+ in: query
2013
+ description: ''
2014
+ style: form
2015
+ explode: true
2016
+ schema:
2017
+ type: number
2018
+ format: double
2019
+ - name: deviceSerial
2020
+ in: query
2021
+ description: ''
2022
+ style: form
2023
+ explode: true
2024
+ schema:
2025
+ type: number
2026
+ format: double
2027
+ - name: deviceName
2028
+ in: query
2029
+ description: ''
2030
+ style: form
2031
+ explode: true
2032
+ schema:
2033
+ type: number
2034
+ format: double
2035
+ - name: clientIp
2036
+ in: query
2037
+ description: ''
2038
+ style: form
2039
+ explode: true
2040
+ schema:
2041
+ type: number
2042
+ format: double
2043
+ - name: clientMac
2044
+ in: query
2045
+ description: ''
2046
+ style: form
2047
+ explode: true
2048
+ schema:
2049
+ type: number
2050
+ format: double
2051
+ - name: clientName
2052
+ in: query
2053
+ description: ''
2054
+ style: form
2055
+ explode: true
2056
+ schema:
2057
+ type: number
2058
+ format: double
2059
+ - name: smDeviceMac
2060
+ in: query
2061
+ description: ''
2062
+ style: form
2063
+ explode: true
2064
+ schema:
2065
+ type: number
2066
+ format: double
2067
+ - name: smDeviceName
2068
+ in: query
2069
+ description: ''
2070
+ style: form
2071
+ explode: true
2072
+ schema:
2073
+ type: number
2074
+ format: double
2075
+ - name: perPage
2076
+ in: query
2077
+ description: ''
2078
+ style: form
2079
+ explode: true
2080
+ schema:
2081
+ type: number
2082
+ format: double
2083
+ - name: startingAfter
2084
+ in: query
2085
+ description: ''
2086
+ style: form
2087
+ explode: true
2088
+ schema:
2089
+ type: number
2090
+ format: double
2091
+ - name: endingBefore
2092
+ in: query
2093
+ description: ''
2094
+ style: form
2095
+ explode: true
2096
+ schema:
2097
+ type: number
2098
+ format: double
2099
+ - name: networkId
2100
+ in: path
2101
+ description: ''
2102
+ required: true
2103
+ style: simple
2104
+ schema:
2105
+ type: string
2106
+ responses:
2107
+ '200':
2108
+ description: successful operation
2109
+ headers: {}
2110
+ content:
2111
+ application/json:
2112
+ schema:
2113
+ $ref: '#/components/schemas/getNetworkEventsResponse'
2114
+ deprecated: false
2115
+ /api/v0/networks/{networkId}/events/eventTypes:
2116
+ get:
2117
+ tags:
2118
+ - Events
2119
+ summary: getNetworkEventsEventTypes
2120
+ description: List the event type to human-readable description
2121
+ operationId: getNetworkEventsEventTypes
2122
+ parameters:
2123
+ - name: networkId
2124
+ in: path
2125
+ description: networkId
2126
+ required: true
2127
+ style: simple
2128
+ schema:
2129
+ type: string
2130
+ responses:
2131
+ '200':
2132
+ description: successful operation
2133
+ headers: {}
2134
+ content:
2135
+ application/json:
2136
+ schema:
2137
+ minItems: 1
2138
+ uniqueItems: true
2139
+ type: array
2140
+ items:
2141
+ $ref: '#/components/schemas/getNetworkEventsEventTypesResponse'
2142
+ description: successful operation
2143
+ deprecated: false
2144
+ /api/v0/networks/{networkId}/floorPlans:
2145
+ get:
2146
+ tags:
2147
+ - Floorplans
2148
+ summary: getNetworkFloorPlans
2149
+ description: List the floor plans that belong to your network
2150
+ operationId: getNetworkFloorPlans
2151
+ parameters:
2152
+ - name: networkId
2153
+ in: path
2154
+ description: networkId
2155
+ required: true
2156
+ style: simple
2157
+ schema:
2158
+ type: string
2159
+ responses:
2160
+ '200':
2161
+ description: successful operation
2162
+ headers: {}
2163
+ content:
2164
+ application/json:
2165
+ schema:
2166
+ minItems: 1
2167
+ uniqueItems: true
2168
+ type: array
2169
+ items:
2170
+ $ref: '#/components/schemas/getNetworkFloorPlansResponse'
2171
+ description: successful operation
2172
+ deprecated: false
2173
+ post:
2174
+ tags:
2175
+ - Floorplans
2176
+ summary: createNetworkFloorPlan
2177
+ description: Upload a floor plan
2178
+ operationId: createNetworkFloorPlan
2179
+ parameters:
2180
+ - name: networkId
2181
+ in: path
2182
+ description: networkId
2183
+ required: true
2184
+ style: simple
2185
+ schema:
2186
+ type: string
2187
+ requestBody:
2188
+ description: body
2189
+ content:
2190
+ text/plain:
2191
+ schema:
2192
+ type: string
2193
+ description: body
2194
+ required: false
2195
+ responses:
2196
+ '200':
2197
+ description: successful operation
2198
+ headers: {}
2199
+ content:
2200
+ text/plain:
2201
+ schema:
2202
+ type: string
2203
+ description: successful operation
2204
+ deprecated: false
2205
+ /api/v0/networks/{networkId}/floorPlans/{floorPlanId}:
2206
+ get:
2207
+ tags:
2208
+ - Floorplans
2209
+ summary: getNetworkFloorPlan
2210
+ description: Find a floor plan by ID
2211
+ operationId: getNetworkFloorPlan
2212
+ parameters:
2213
+ - name: networkId
2214
+ in: path
2215
+ description: networkId
2216
+ required: true
2217
+ style: simple
2218
+ schema:
2219
+ type: string
2220
+ - name: floorPlanId
2221
+ in: path
2222
+ description: floorPlanId
2223
+ required: true
2224
+ style: simple
2225
+ schema:
2226
+ type: string
2227
+ responses:
2228
+ '200':
2229
+ description: successful operation
2230
+ headers: {}
2231
+ content:
2232
+ application/json:
2233
+ schema:
2234
+ $ref: '#/components/schemas/getNetworkFloorPlanResponse'
2235
+ deprecated: false
2236
+ put:
2237
+ tags:
2238
+ - Floorplans
2239
+ summary: updateNetworkFloorPlan
2240
+ description: Update a floor plan's geolocation and other meta data
2241
+ operationId: updateNetworkFloorPlan
2242
+ parameters:
2243
+ - name: networkId
2244
+ in: path
2245
+ description: networkId
2246
+ required: true
2247
+ style: simple
2248
+ schema:
2249
+ type: string
2250
+ - name: floorPlanId
2251
+ in: path
2252
+ description: floorPlanId
2253
+ required: true
2254
+ style: simple
2255
+ schema:
2256
+ type: string
2257
+ requestBody:
2258
+ description: body
2259
+ content:
2260
+ text/plain:
2261
+ schema:
2262
+ type: string
2263
+ description: body
2264
+ required: false
2265
+ responses:
2266
+ '200':
2267
+ description: successful operation
2268
+ headers: {}
2269
+ content:
2270
+ application/json:
2271
+ schema:
2272
+ $ref: '#/components/schemas/updateNetworkFloorPlanResponse'
2273
+ deprecated: false
2274
+ delete:
2275
+ tags:
2276
+ - Floorplans
2277
+ summary: deleteNetworkFloorPlan
2278
+ description: Destroy a floor plan
2279
+ operationId: deleteNetworkFloorPlan
2280
+ parameters:
2281
+ - name: networkId
2282
+ in: path
2283
+ description: networkId
2284
+ required: true
2285
+ style: simple
2286
+ schema:
2287
+ type: string
2288
+ - name: floorPlanId
2289
+ in: path
2290
+ description: floorPlanId
2291
+ required: true
2292
+ style: simple
2293
+ schema:
2294
+ type: string
2295
+ responses:
2296
+ '200':
2297
+ description: successful operation
2298
+ headers: {}
2299
+ content:
2300
+ text/plain:
2301
+ schema:
2302
+ type: string
2303
+ description: successful operation
2304
+ deprecated: false
2305
+ /api/v0/networks/{networkId}/switch/linkAggregations:
2306
+ get:
2307
+ tags:
2308
+ - LinkAggregations
2309
+ summary: getNetworkSwitchLinkAggregations
2310
+ description: List link aggregation groups
2311
+ operationId: getNetworkSwitchLinkAggregations
2312
+ parameters:
2313
+ - name: networkId
2314
+ in: path
2315
+ description: networkId
2316
+ required: true
2317
+ style: simple
2318
+ schema:
2319
+ type: string
2320
+ responses:
2321
+ '200':
2322
+ description: successful operation
2323
+ headers: {}
2324
+ content:
2325
+ application/json:
2326
+ schema:
2327
+ minItems: 1
2328
+ uniqueItems: true
2329
+ type: array
2330
+ items:
2331
+ $ref: '#/components/schemas/getNetworkSwitchLinkAggregationsResponse'
2332
+ description: successful operation
2333
+ deprecated: false
2334
+ post:
2335
+ tags:
2336
+ - LinkAggregations
2337
+ summary: createNetworkSwitchLinkAggregation
2338
+ description: Create a link aggregation group
2339
+ operationId: createNetworkSwitchLinkAggregation
2340
+ parameters:
2341
+ - name: networkId
2342
+ in: path
2343
+ description: networkId
2344
+ required: true
2345
+ style: simple
2346
+ schema:
2347
+ type: string
2348
+ requestBody:
2349
+ description: body
2350
+ content:
2351
+ text/plain:
2352
+ schema:
2353
+ type: string
2354
+ description: body
2355
+ required: false
2356
+ responses:
2357
+ '200':
2358
+ description: successful operation
2359
+ headers: {}
2360
+ content:
2361
+ application/json:
2362
+ schema:
2363
+ $ref: '#/components/schemas/createNetworkSwitchLinkAggregationResponse'
2364
+ deprecated: false
2365
+ /api/v0/networks/{networkId}/switch/linkAggregations/{linkAggregationId}:
2366
+ put:
2367
+ tags:
2368
+ - LinkAggregations
2369
+ summary: updateNetworkSwitchLinkAggregation
2370
+ description: Update a link aggregation group
2371
+ operationId: updateNetworkSwitchLinkAggregation
2372
+ parameters:
2373
+ - name: networkId
2374
+ in: path
2375
+ description: networkId
2376
+ required: true
2377
+ style: simple
2378
+ schema:
2379
+ type: string
2380
+ - name: linkAggregationId
2381
+ in: path
2382
+ description: linkAggregationId
2383
+ required: true
2384
+ style: simple
2385
+ schema:
2386
+ type: string
2387
+ requestBody:
2388
+ description: body
2389
+ content:
2390
+ text/plain:
2391
+ schema:
2392
+ type: string
2393
+ description: body
2394
+ required: false
2395
+ responses:
2396
+ '200':
2397
+ description: successful operation
2398
+ headers: {}
2399
+ content:
2400
+ application/json:
2401
+ schema:
2402
+ $ref: '#/components/schemas/updateNetworkSwitchLinkAggregationResponse'
2403
+ deprecated: false
2404
+ delete:
2405
+ tags:
2406
+ - LinkAggregations
2407
+ summary: deleteNetworkSwitchLinkAggregation
2408
+ description: Split a link aggregation group into separate ports
2409
+ operationId: deleteNetworkSwitchLinkAggregation
2410
+ parameters:
2411
+ - name: networkId
2412
+ in: path
2413
+ description: networkId
2414
+ required: true
2415
+ style: simple
2416
+ schema:
2417
+ type: string
2418
+ - name: linkAggregationId
2419
+ in: path
2420
+ description: linkAggregationId
2421
+ required: true
2422
+ style: simple
2423
+ schema:
2424
+ type: string
2425
+ responses:
2426
+ '200':
2427
+ description: successful operation
2428
+ headers: {}
2429
+ content:
2430
+ text/plain:
2431
+ schema:
2432
+ type: string
2433
+ description: successful operation
2434
+ deprecated: false
2435
+ /api/v0/networks/{networkId}/staticRoutes:
2436
+ get:
2437
+ tags:
2438
+ - MXStaticRoutes
2439
+ summary: getNetworkStaticRoutes
2440
+ description: List the static routes for an MX or teleworker network
2441
+ operationId: getNetworkStaticRoutes
2442
+ parameters:
2443
+ - name: networkId
2444
+ in: path
2445
+ description: networkId
2446
+ required: true
2447
+ style: simple
2448
+ schema:
2449
+ type: string
2450
+ responses:
2451
+ '200':
2452
+ description: successful operation
2453
+ headers: {}
2454
+ content:
2455
+ application/json:
2456
+ schema:
2457
+ minItems: 1
2458
+ uniqueItems: true
2459
+ type: array
2460
+ items:
2461
+ $ref: '#/components/schemas/getNetworkStaticRoutesResponse'
2462
+ description: successful operation
2463
+ deprecated: false
2464
+ post:
2465
+ tags:
2466
+ - MXStaticRoutes
2467
+ summary: createNetworkStaticRoute
2468
+ description: Add a static route for an MX or teleworker network
2469
+ operationId: createNetworkStaticRoute
2470
+ parameters:
2471
+ - name: networkId
2472
+ in: path
2473
+ description: networkId
2474
+ required: true
2475
+ style: simple
2476
+ schema:
2477
+ type: string
2478
+ responses:
2479
+ '200':
2480
+ description: successful operation
2481
+ headers: {}
2482
+ content:
2483
+ text/plain:
2484
+ schema:
2485
+ type: string
2486
+ description: successful operation
2487
+ deprecated: false
2488
+ /api/v0/networks/{networkId}/staticRoutes/{srId}:
2489
+ get:
2490
+ tags:
2491
+ - MXStaticRoutes
2492
+ summary: getNetworkStaticRoute
2493
+ description: Return a static route for an MX or teleworker network
2494
+ operationId: getNetworkStaticRoute
2495
+ parameters:
2496
+ - name: networkId
2497
+ in: path
2498
+ description: networkId
2499
+ required: true
2500
+ style: simple
2501
+ schema:
2502
+ type: string
2503
+ - name: srId
2504
+ in: path
2505
+ description: srId
2506
+ required: true
2507
+ style: simple
2508
+ schema:
2509
+ type: string
2510
+ responses:
2511
+ '200':
2512
+ description: successful operation
2513
+ headers: {}
2514
+ content:
2515
+ text/plain:
2516
+ schema:
2517
+ type: string
2518
+ description: successful operation
2519
+ deprecated: false
2520
+ put:
2521
+ tags:
2522
+ - MXStaticRoutes
2523
+ summary: updateNetworkStaticRoute
2524
+ description: Update a static route for an MX or teleworker network
2525
+ operationId: updateNetworkStaticRoute
2526
+ parameters:
2527
+ - name: networkId
2528
+ in: path
2529
+ description: networkId
2530
+ required: true
2531
+ style: simple
2532
+ schema:
2533
+ type: string
2534
+ - name: srId
2535
+ in: path
2536
+ description: srId
2537
+ required: true
2538
+ style: simple
2539
+ schema:
2540
+ type: string
2541
+ requestBody:
2542
+ description: body
2543
+ content:
2544
+ text/plain:
2545
+ schema:
2546
+ type: string
2547
+ description: body
2548
+ required: false
2549
+ responses:
2550
+ '200':
2551
+ description: successful operation
2552
+ headers: {}
2553
+ content:
2554
+ application/json:
2555
+ schema:
2556
+ $ref: '#/components/schemas/updateNetworkStaticRouteResponse'
2557
+ deprecated: false
2558
+ delete:
2559
+ tags:
2560
+ - MXStaticRoutes
2561
+ summary: ApiV0NetworksStaticRoutesByNetworkId_DELETE
2562
+ description: ApiV0NetworksStaticRoutesByNetworkId_DELETE
2563
+ operationId: ApiV0NetworksStaticRoutesByNetworkId_DELETE
2564
+ parameters:
2565
+ - name: networkId
2566
+ in: path
2567
+ description: networkId
2568
+ required: true
2569
+ style: simple
2570
+ schema:
2571
+ type: string
2572
+ - name: srId
2573
+ in: path
2574
+ description: srId
2575
+ required: true
2576
+ style: simple
2577
+ schema:
2578
+ type: string
2579
+ responses:
2580
+ '200':
2581
+ description: successful operation
2582
+ headers: {}
2583
+ content:
2584
+ text/plain:
2585
+ schema:
2586
+ type: string
2587
+ description: successful operation
2588
+ deprecated: false
2589
+ /api/v0/networks/{networkId}/netflowSettings:
2590
+ get:
2591
+ tags:
2592
+ - NetFlowSettings
2593
+ summary: getNetworkNetflowSettings
2594
+ description: Return the NetFlow traffic reporting settings for a network
2595
+ operationId: getNetworkNetflowSettings
2596
+ parameters:
2597
+ - name: networkId
2598
+ in: path
2599
+ description: networkId
2600
+ required: true
2601
+ style: simple
2602
+ schema:
2603
+ type: string
2604
+ responses:
2605
+ '200':
2606
+ description: successful operation
2607
+ headers: {}
2608
+ content:
2609
+ application/json:
2610
+ schema:
2611
+ $ref: '#/components/schemas/getNetworkNetflowSettingsResponse'
2612
+ deprecated: false
2613
+ put:
2614
+ tags:
2615
+ - NetFlowSettings
2616
+ summary: updateNetworkNetflowSettings
2617
+ description: Update the NetFlow traffic reporting settings for a network
2618
+ operationId: updateNetworkNetflowSettings
2619
+ parameters:
2620
+ - name: networkId
2621
+ in: path
2622
+ description: networkId
2623
+ required: true
2624
+ style: simple
2625
+ schema:
2626
+ type: string
2627
+ requestBody:
2628
+ description: body
2629
+ content:
2630
+ text/plain:
2631
+ schema:
2632
+ type: string
2633
+ description: body
2634
+ required: false
2635
+ responses:
2636
+ '200':
2637
+ description: successful operation
2638
+ headers: {}
2639
+ content:
2640
+ application/json:
2641
+ schema:
2642
+ $ref: '#/components/schemas/updateNetworkNetflowSettingsResponse'
2643
+ deprecated: false
2644
+ /api/v0/networks/{networkId}/trafficAnalysisSettings:
2645
+ get:
2646
+ tags:
2647
+ - TrafficAnalysisSettings
2648
+ summary: getNetworkTrafficAnalysisSettings
2649
+ description: Return the traffic analysis settings for a network
2650
+ operationId: getNetworkTrafficAnalysisSettings
2651
+ parameters:
2652
+ - name: networkId
2653
+ in: path
2654
+ description: networkId
2655
+ required: true
2656
+ style: simple
2657
+ schema:
2658
+ type: string
2659
+ responses:
2660
+ '200':
2661
+ description: successful operation
2662
+ headers: {}
2663
+ content:
2664
+ application/json:
2665
+ schema:
2666
+ $ref: '#/components/schemas/getNetworkTrafficAnalysisSettingsResponse'
2667
+ deprecated: false
2668
+ put:
2669
+ tags:
2670
+ - TrafficAnalysisSettings
2671
+ summary: updateNetworkTrafficAnalysisSettings
2672
+ description: Update the traffic analysis settings for a network
2673
+ operationId: updateNetworkTrafficAnalysisSettings
2674
+ parameters:
2675
+ - name: networkId
2676
+ in: path
2677
+ description: networkId
2678
+ required: true
2679
+ style: simple
2680
+ schema:
2681
+ type: string
2682
+ responses:
2683
+ '200':
2684
+ description: successful operation
2685
+ headers: {}
2686
+ content:
2687
+ application/json:
2688
+ schema:
2689
+ $ref: '#/components/schemas/updateNetworkTrafficAnalysisSettingsResponse'
2690
+ deprecated: false
2691
+ /api/v0/organizations/{organizationId}/webhookLogs:
2692
+ get:
2693
+ tags:
2694
+ - WebhookLogs
2695
+ summary: getOrganizationWebhookLogs
2696
+ description: Return the log of webhook POSTs sent
2697
+ operationId: getOrganizationWebhookLogs
2698
+ parameters:
2699
+ - name: t0
2700
+ in: query
2701
+ description: ''
2702
+ style: form
2703
+ explode: true
2704
+ schema:
2705
+ type: number
2706
+ format: double
2707
+ - name: t1
2708
+ in: query
2709
+ description: ''
2710
+ style: form
2711
+ explode: true
2712
+ schema:
2713
+ type: number
2714
+ format: double
2715
+ - name: timespan
2716
+ in: query
2717
+ description: ''
2718
+ style: form
2719
+ explode: true
2720
+ schema:
2721
+ type: number
2722
+ format: double
2723
+ - name: perPage
2724
+ in: query
2725
+ description: ''
2726
+ style: form
2727
+ explode: true
2728
+ schema:
2729
+ type: number
2730
+ format: double
2731
+ - name: startingAfter
2732
+ in: query
2733
+ description: ''
2734
+ style: form
2735
+ explode: true
2736
+ schema:
2737
+ type: number
2738
+ format: double
2739
+ - name: endingBefore
2740
+ in: query
2741
+ description: ''
2742
+ style: form
2743
+ explode: true
2744
+ schema:
2745
+ type: number
2746
+ format: double
2747
+ - name: url
2748
+ in: query
2749
+ description: ''
2750
+ style: form
2751
+ explode: true
2752
+ schema:
2753
+ type: number
2754
+ format: double
2755
+ - name: organizationId
2756
+ in: path
2757
+ description: ''
2758
+ required: true
2759
+ style: simple
2760
+ schema:
2761
+ type: string
2762
+ responses:
2763
+ '200':
2764
+ description: successful operation
2765
+ headers: {}
2766
+ content:
2767
+ application/json:
2768
+ schema:
2769
+ minItems: 1
2770
+ uniqueItems: true
2771
+ type: array
2772
+ items:
2773
+ $ref: '#/components/schemas/getOrganizationWebhookLogsResponse'
2774
+ description: successful operation
2775
+ deprecated: false
2776
+ /api/v0/networks/{networkId}/wireless/settings:
2777
+ get:
2778
+ tags:
2779
+ - WirelessSettings
2780
+ summary: getNetworkWirelessSettings
2781
+ description: Return the wireless settings for a network
2782
+ operationId: getNetworkWirelessSettings
2783
+ parameters:
2784
+ - name: networkId
2785
+ in: path
2786
+ description: networkId
2787
+ required: true
2788
+ style: simple
2789
+ schema:
2790
+ type: string
2791
+ responses:
2792
+ '200':
2793
+ description: successful operation
2794
+ headers: {}
2795
+ content:
2796
+ application/json:
2797
+ schema:
2798
+ $ref: '#/components/schemas/getNetworkWirelessSettingsResponse'
2799
+ deprecated: false
2800
+ put:
2801
+ tags:
2802
+ - WirelessSettings
2803
+ summary: updateNetworkWirelessSettings
2804
+ description: Update the wireless settings for a network
2805
+ operationId: updateNetworkWirelessSettings
2806
+ parameters:
2807
+ - name: networkId
2808
+ in: path
2809
+ description: networkId
2810
+ required: true
2811
+ style: simple
2812
+ schema:
2813
+ type: string
2814
+ requestBody:
2815
+ description: body
2816
+ content:
2817
+ text/plain:
2818
+ schema:
2819
+ type: string
2820
+ description: body
2821
+ required: false
2822
+ responses:
2823
+ '200':
2824
+ description: successful operation
2825
+ headers: {}
2826
+ content:
2827
+ application/json:
2828
+ schema:
2829
+ $ref: '#/components/schemas/updateNetworkWirelessSettingsResponse'
2830
+ deprecated: false
2831
+ components:
2832
+ schemas:
2833
+ getNetworkConnectivityMonitoringDestinationsResponse:
2834
+ title: getNetworkConnectivityMonitoringDestinationsResponse
2835
+ required:
2836
+ - destinations
2837
+ type: object
2838
+ properties:
2839
+ destinations:
2840
+ minItems: 1
2841
+ uniqueItems: true
2842
+ type: array
2843
+ items:
2844
+ $ref: '#/components/schemas/Destination'
2845
+ description: ''
2846
+ Destination:
2847
+ title: Destination
2848
+ required:
2849
+ - ip
2850
+ - description
2851
+ - default
2852
+ type: object
2853
+ properties:
2854
+ ip:
2855
+ minLength: 1
2856
+ type: string
2857
+ description:
2858
+ minLength: 1
2859
+ type: string
2860
+ default:
2861
+ type: boolean
2862
+ getOrganizationBrandingPoliciesResponse:
2863
+ title: getOrganizationBrandingPoliciesResponse
2864
+ required:
2865
+ - brandingPolicyId
2866
+ - name
2867
+ - enabled
2868
+ - adminSettings
2869
+ - helpSettings
2870
+ type: object
2871
+ properties:
2872
+ brandingPolicyId:
2873
+ minLength: 1
2874
+ type: string
2875
+ name:
2876
+ minLength: 1
2877
+ type: string
2878
+ enabled:
2879
+ type: boolean
2880
+ adminSettings:
2881
+ $ref: '#/components/schemas/AdminSettings'
2882
+ helpSettings:
2883
+ $ref: '#/components/schemas/HelpSettings'
2884
+ AdminSettings:
2885
+ title: AdminSettings
2886
+ required:
2887
+ - appliesTo
2888
+ - values
2889
+ type: object
2890
+ properties:
2891
+ appliesTo:
2892
+ minLength: 1
2893
+ type: string
2894
+ values:
2895
+ type: array
2896
+ items:
2897
+ type: object
2898
+ description: ''
2899
+ HelpSettings:
2900
+ title: HelpSettings
2901
+ required:
2902
+ - helpTab
2903
+ - getHelpSubtab
2904
+ - communitySubtab
2905
+ - casesSubtab
2906
+ - dataProtectionRequestsSubtab
2907
+ - getHelpSubtabKnowledgeBaseSearch
2908
+ - universalSearchKnowledgeBaseSearch
2909
+ - ciscoMerakiProductDocumentation
2910
+ - supportContactInfo
2911
+ - newFeaturesSubtab
2912
+ - firewallInfoSubtab
2913
+ - apiDocsSubtab
2914
+ - hardwareReplacementsSubtab
2915
+ - smForums
2916
+ type: object
2917
+ properties:
2918
+ helpTab:
2919
+ minLength: 1
2920
+ type: string
2921
+ getHelpSubtab:
2922
+ minLength: 1
2923
+ type: string
2924
+ communitySubtab:
2925
+ minLength: 1
2926
+ type: string
2927
+ casesSubtab:
2928
+ minLength: 1
2929
+ type: string
2930
+ dataProtectionRequestsSubtab:
2931
+ minLength: 1
2932
+ type: string
2933
+ getHelpSubtabKnowledgeBaseSearch:
2934
+ minLength: 1
2935
+ type: string
2936
+ universalSearchKnowledgeBaseSearch:
2937
+ minLength: 1
2938
+ type: string
2939
+ ciscoMerakiProductDocumentation:
2940
+ minLength: 1
2941
+ type: string
2942
+ supportContactInfo:
2943
+ minLength: 1
2944
+ type: string
2945
+ newFeaturesSubtab:
2946
+ minLength: 1
2947
+ type: string
2948
+ firewallInfoSubtab:
2949
+ minLength: 1
2950
+ type: string
2951
+ apiDocsSubtab:
2952
+ minLength: 1
2953
+ type: string
2954
+ hardwareReplacementsSubtab:
2955
+ minLength: 1
2956
+ type: string
2957
+ smForums:
2958
+ minLength: 1
2959
+ type: string
2960
+ createOrganizationBrandingPolicyResponse:
2961
+ title: createOrganizationBrandingPolicyResponse
2962
+ required:
2963
+ - brandingPolicyId
2964
+ - name
2965
+ - enabled
2966
+ - adminSettings
2967
+ - helpSettings
2968
+ type: object
2969
+ properties:
2970
+ brandingPolicyId:
2971
+ minLength: 1
2972
+ type: string
2973
+ name:
2974
+ minLength: 1
2975
+ type: string
2976
+ enabled:
2977
+ type: boolean
2978
+ adminSettings:
2979
+ $ref: '#/components/schemas/AdminSettings'
2980
+ helpSettings:
2981
+ $ref: '#/components/schemas/HelpSettings'
2982
+ getOrganizationBrandingPoliciesPrioritiesResponse:
2983
+ title: getOrganizationBrandingPoliciesPrioritiesResponse
2984
+ required:
2985
+ - brandingPolicyIds
2986
+ type: object
2987
+ properties:
2988
+ brandingPolicyIds:
2989
+ type: array
2990
+ items:
2991
+ type: object
2992
+ description: ''
2993
+ updateOrganizationBrandingPoliciesPrioritiesResponse:
2994
+ title: updateOrganizationBrandingPoliciesPrioritiesResponse
2995
+ required:
2996
+ - brandingPolicyIds
2997
+ type: object
2998
+ properties:
2999
+ brandingPolicyIds:
3000
+ type: array
3001
+ items:
3002
+ type: object
3003
+ description: ''
3004
+ getOrganizationBrandingPolicyResponse:
3005
+ title: getOrganizationBrandingPolicyResponse
3006
+ required:
3007
+ - brandingPolicyId
3008
+ - name
3009
+ - enabled
3010
+ - adminSettings
3011
+ - helpSettings
3012
+ type: object
3013
+ properties:
3014
+ brandingPolicyId:
3015
+ minLength: 1
3016
+ type: string
3017
+ name:
3018
+ minLength: 1
3019
+ type: string
3020
+ enabled:
3021
+ type: boolean
3022
+ adminSettings:
3023
+ $ref: '#/components/schemas/AdminSettings'
3024
+ helpSettings:
3025
+ $ref: '#/components/schemas/HelpSettings'
3026
+ updateOrganizationBrandingPolicyResponse:
3027
+ title: updateOrganizationBrandingPolicyResponse
3028
+ required:
3029
+ - brandingPolicyId
3030
+ - name
3031
+ - enabled
3032
+ - adminSettings
3033
+ - helpSettings
3034
+ type: object
3035
+ properties:
3036
+ brandingPolicyId:
3037
+ minLength: 1
3038
+ type: string
3039
+ name:
3040
+ minLength: 1
3041
+ type: string
3042
+ enabled:
3043
+ type: boolean
3044
+ adminSettings:
3045
+ $ref: '#/components/schemas/AdminSettings'
3046
+ helpSettings:
3047
+ $ref: '#/components/schemas/HelpSettings'
3048
+ getNetworkEventsResponse:
3049
+ title: getNetworkEventsResponse
3050
+ required:
3051
+ - pageStartAt
3052
+ - pageEndAt
3053
+ - events
3054
+ type: object
3055
+ properties:
3056
+ message:
3057
+ type: object
3058
+ pageStartAt:
3059
+ minLength: 1
3060
+ type: string
3061
+ pageEndAt:
3062
+ minLength: 1
3063
+ type: string
3064
+ events:
3065
+ minItems: 1
3066
+ uniqueItems: true
3067
+ type: array
3068
+ items:
3069
+ $ref: '#/components/schemas/Event'
3070
+ description: ''
3071
+ Event:
3072
+ title: Event
3073
+ required:
3074
+ - occurredAt
3075
+ - networkId
3076
+ - type
3077
+ - description
3078
+ - clientId
3079
+ - clientDescription
3080
+ - deviceSerial
3081
+ - deviceName
3082
+ - ssidNumber
3083
+ - ssidName
3084
+ type: object
3085
+ properties:
3086
+ occurredAt:
3087
+ minLength: 1
3088
+ type: string
3089
+ networkId:
3090
+ minLength: 1
3091
+ type: string
3092
+ type:
3093
+ minLength: 1
3094
+ type: string
3095
+ description:
3096
+ minLength: 1
3097
+ type: string
3098
+ clientId:
3099
+ minLength: 1
3100
+ type: string
3101
+ clientDescription:
3102
+ minLength: 1
3103
+ type: string
3104
+ deviceSerial:
3105
+ minLength: 1
3106
+ type: string
3107
+ deviceName:
3108
+ minLength: 1
3109
+ type: string
3110
+ ssidNumber:
3111
+ type: number
3112
+ ssidName:
3113
+ minLength: 1
3114
+ type: string
3115
+ eventData:
3116
+ $ref: '#/components/schemas/EventData'
3117
+ EventData:
3118
+ title: EventData
3119
+ required:
3120
+ - radio
3121
+ - vap
3122
+ - client_mac
3123
+ - client_ip
3124
+ - channel
3125
+ - rssi
3126
+ - aid
3127
+ type: object
3128
+ properties:
3129
+ radio:
3130
+ minLength: 1
3131
+ type: string
3132
+ vap:
3133
+ minLength: 1
3134
+ type: string
3135
+ client_mac:
3136
+ minLength: 1
3137
+ type: string
3138
+ client_ip:
3139
+ minLength: 1
3140
+ type: string
3141
+ channel:
3142
+ minLength: 1
3143
+ type: string
3144
+ rssi:
3145
+ minLength: 1
3146
+ type: string
3147
+ aid:
3148
+ minLength: 1
3149
+ type: string
3150
+ getNetworkEventsEventTypesResponse:
3151
+ title: getNetworkEventsEventTypesResponse
3152
+ required:
3153
+ - category
3154
+ - type
3155
+ - description
3156
+ type: object
3157
+ properties:
3158
+ category:
3159
+ minLength: 1
3160
+ type: string
3161
+ type:
3162
+ minLength: 1
3163
+ type: string
3164
+ description:
3165
+ minLength: 1
3166
+ type: string
3167
+ getNetworkFloorPlansResponse:
3168
+ title: getNetworkFloorPlansResponse
3169
+ required:
3170
+ - floorPlanId
3171
+ - imageUrl
3172
+ - imageUrlExpiresAt
3173
+ - imageExtension
3174
+ - imageMd5
3175
+ - name
3176
+ - devices
3177
+ - width
3178
+ - height
3179
+ - center
3180
+ - bottomLeftCorner
3181
+ - bottomRightCorner
3182
+ - topLeftCorner
3183
+ - topRightCorner
3184
+ type: object
3185
+ properties:
3186
+ floorPlanId:
3187
+ minLength: 1
3188
+ type: string
3189
+ imageUrl:
3190
+ minLength: 1
3191
+ type: string
3192
+ imageUrlExpiresAt:
3193
+ minLength: 1
3194
+ type: string
3195
+ imageExtension:
3196
+ minLength: 1
3197
+ type: string
3198
+ imageMd5:
3199
+ minLength: 1
3200
+ type: string
3201
+ name:
3202
+ minLength: 1
3203
+ type: string
3204
+ devices:
3205
+ minItems: 1
3206
+ uniqueItems: true
3207
+ type: array
3208
+ items:
3209
+ $ref: '#/components/schemas/Device'
3210
+ description: ''
3211
+ width:
3212
+ type: number
3213
+ height:
3214
+ type: number
3215
+ center:
3216
+ $ref: '#/components/schemas/Center'
3217
+ bottomLeftCorner:
3218
+ $ref: '#/components/schemas/BottomLeftCorner'
3219
+ bottomRightCorner:
3220
+ $ref: '#/components/schemas/BottomRightCorner'
3221
+ topLeftCorner:
3222
+ $ref: '#/components/schemas/TopLeftCorner'
3223
+ topRightCorner:
3224
+ $ref: '#/components/schemas/TopRightCorner'
3225
+ Device:
3226
+ title: Device
3227
+ required:
3228
+ - name
3229
+ - lat
3230
+ - lng
3231
+ - serial
3232
+ - mac
3233
+ - model
3234
+ - address
3235
+ - notes
3236
+ - lanIp
3237
+ - tags
3238
+ - networkId
3239
+ - firmware
3240
+ - floorPlanId
3241
+ type: object
3242
+ properties:
3243
+ name:
3244
+ minLength: 1
3245
+ type: string
3246
+ lat:
3247
+ type: number
3248
+ lng:
3249
+ type: number
3250
+ serial:
3251
+ minLength: 1
3252
+ type: string
3253
+ mac:
3254
+ minLength: 1
3255
+ type: string
3256
+ model:
3257
+ minLength: 1
3258
+ type: string
3259
+ address:
3260
+ minLength: 1
3261
+ type: string
3262
+ notes:
3263
+ minLength: 1
3264
+ type: string
3265
+ lanIp:
3266
+ minLength: 1
3267
+ type: string
3268
+ tags:
3269
+ minLength: 1
3270
+ type: string
3271
+ networkId:
3272
+ minLength: 1
3273
+ type: string
3274
+ beaconIdParams:
3275
+ $ref: '#/components/schemas/BeaconIdParams'
3276
+ firmware:
3277
+ minLength: 1
3278
+ type: string
3279
+ floorPlanId:
3280
+ minLength: 1
3281
+ type: string
3282
+ BeaconIdParams:
3283
+ title: BeaconIdParams
3284
+ required:
3285
+ - uuid
3286
+ - major
3287
+ - minor
3288
+ type: object
3289
+ properties:
3290
+ uuid:
3291
+ minLength: 1
3292
+ type: string
3293
+ major:
3294
+ type: number
3295
+ minor:
3296
+ type: number
3297
+ Center:
3298
+ title: Center
3299
+ required:
3300
+ - lat
3301
+ - lng
3302
+ type: object
3303
+ properties:
3304
+ lat:
3305
+ type: number
3306
+ lng:
3307
+ type: number
3308
+ BottomLeftCorner:
3309
+ title: BottomLeftCorner
3310
+ required:
3311
+ - lat
3312
+ - lng
3313
+ type: object
3314
+ properties:
3315
+ lat:
3316
+ type: number
3317
+ lng:
3318
+ type: number
3319
+ BottomRightCorner:
3320
+ title: BottomRightCorner
3321
+ required:
3322
+ - lat
3323
+ - lng
3324
+ type: object
3325
+ properties:
3326
+ lat:
3327
+ type: number
3328
+ lng:
3329
+ type: number
3330
+ TopLeftCorner:
3331
+ title: TopLeftCorner
3332
+ required:
3333
+ - lat
3334
+ - lng
3335
+ type: object
3336
+ properties:
3337
+ lat:
3338
+ type: number
3339
+ lng:
3340
+ type: number
3341
+ TopRightCorner:
3342
+ title: TopRightCorner
3343
+ required:
3344
+ - lat
3345
+ - lng
3346
+ type: object
3347
+ properties:
3348
+ lat:
3349
+ type: number
3350
+ lng:
3351
+ type: number
3352
+ getNetworkFloorPlanResponse:
3353
+ title: getNetworkFloorPlanResponse
3354
+ required:
3355
+ - floorPlanId
3356
+ - imageUrl
3357
+ - imageUrlExpiresAt
3358
+ - imageExtension
3359
+ - imageMd5
3360
+ - name
3361
+ - devices
3362
+ - width
3363
+ - height
3364
+ - center
3365
+ - bottomLeftCorner
3366
+ - bottomRightCorner
3367
+ - topLeftCorner
3368
+ - topRightCorner
3369
+ type: object
3370
+ properties:
3371
+ floorPlanId:
3372
+ minLength: 1
3373
+ type: string
3374
+ imageUrl:
3375
+ minLength: 1
3376
+ type: string
3377
+ imageUrlExpiresAt:
3378
+ minLength: 1
3379
+ type: string
3380
+ imageExtension:
3381
+ minLength: 1
3382
+ type: string
3383
+ imageMd5:
3384
+ minLength: 1
3385
+ type: string
3386
+ name:
3387
+ minLength: 1
3388
+ type: string
3389
+ devices:
3390
+ minItems: 1
3391
+ uniqueItems: true
3392
+ type: array
3393
+ items:
3394
+ $ref: '#/components/schemas/Device'
3395
+ description: ''
3396
+ width:
3397
+ type: number
3398
+ height:
3399
+ type: number
3400
+ center:
3401
+ $ref: '#/components/schemas/Center'
3402
+ bottomLeftCorner:
3403
+ $ref: '#/components/schemas/BottomLeftCorner'
3404
+ bottomRightCorner:
3405
+ $ref: '#/components/schemas/BottomRightCorner'
3406
+ topLeftCorner:
3407
+ $ref: '#/components/schemas/TopLeftCorner'
3408
+ topRightCorner:
3409
+ $ref: '#/components/schemas/TopRightCorner'
3410
+ updateNetworkFloorPlanResponse:
3411
+ title: updateNetworkFloorPlanResponse
3412
+ required:
3413
+ - floorPlanId
3414
+ - imageUrl
3415
+ - imageUrlExpiresAt
3416
+ - imageExtension
3417
+ - imageMd5
3418
+ - name
3419
+ - devices
3420
+ - width
3421
+ - height
3422
+ - center
3423
+ - bottomLeftCorner
3424
+ - bottomRightCorner
3425
+ - topLeftCorner
3426
+ - topRightCorner
3427
+ type: object
3428
+ properties:
3429
+ floorPlanId:
3430
+ minLength: 1
3431
+ type: string
3432
+ imageUrl:
3433
+ minLength: 1
3434
+ type: string
3435
+ imageUrlExpiresAt:
3436
+ minLength: 1
3437
+ type: string
3438
+ imageExtension:
3439
+ minLength: 1
3440
+ type: string
3441
+ imageMd5:
3442
+ minLength: 1
3443
+ type: string
3444
+ name:
3445
+ minLength: 1
3446
+ type: string
3447
+ devices:
3448
+ minItems: 1
3449
+ uniqueItems: true
3450
+ type: array
3451
+ items:
3452
+ $ref: '#/components/schemas/Device'
3453
+ description: ''
3454
+ width:
3455
+ type: number
3456
+ height:
3457
+ type: number
3458
+ center:
3459
+ $ref: '#/components/schemas/Center'
3460
+ bottomLeftCorner:
3461
+ $ref: '#/components/schemas/BottomLeftCorner'
3462
+ bottomRightCorner:
3463
+ $ref: '#/components/schemas/BottomRightCorner'
3464
+ topLeftCorner:
3465
+ $ref: '#/components/schemas/TopLeftCorner'
3466
+ topRightCorner:
3467
+ $ref: '#/components/schemas/TopRightCorner'
3468
+ getNetworkSwitchLinkAggregationsResponse:
3469
+ title: getNetworkSwitchLinkAggregationsResponse
3470
+ required:
3471
+ - id
3472
+ - switchPorts
3473
+ type: object
3474
+ properties:
3475
+ id:
3476
+ minLength: 1
3477
+ type: string
3478
+ switchPorts:
3479
+ minItems: 1
3480
+ uniqueItems: true
3481
+ type: array
3482
+ items:
3483
+ $ref: '#/components/schemas/SwitchPort'
3484
+ description: ''
3485
+ SwitchPort:
3486
+ title: SwitchPort
3487
+ required:
3488
+ - serial
3489
+ - portId
3490
+ type: object
3491
+ properties:
3492
+ serial:
3493
+ minLength: 1
3494
+ type: string
3495
+ portId:
3496
+ minLength: 1
3497
+ type: string
3498
+ createNetworkSwitchLinkAggregationResponse:
3499
+ title: createNetworkSwitchLinkAggregationResponse
3500
+ required:
3501
+ - id
3502
+ - switchPorts
3503
+ type: object
3504
+ properties:
3505
+ id:
3506
+ minLength: 1
3507
+ type: string
3508
+ switchPorts:
3509
+ minItems: 1
3510
+ uniqueItems: true
3511
+ type: array
3512
+ items:
3513
+ $ref: '#/components/schemas/SwitchPort'
3514
+ description: ''
3515
+ updateNetworkSwitchLinkAggregationResponse:
3516
+ title: updateNetworkSwitchLinkAggregationResponse
3517
+ required:
3518
+ - id
3519
+ - switchPorts
3520
+ type: object
3521
+ properties:
3522
+ id:
3523
+ minLength: 1
3524
+ type: string
3525
+ switchPorts:
3526
+ minItems: 1
3527
+ uniqueItems: true
3528
+ type: array
3529
+ items:
3530
+ $ref: '#/components/schemas/SwitchPort'
3531
+ description: ''
3532
+ getNetworkStaticRoutesResponse:
3533
+ title: getNetworkStaticRoutesResponse
3534
+ required:
3535
+ - id
3536
+ - networkId
3537
+ - name
3538
+ - gatewayIp
3539
+ - subnet
3540
+ - fixedIpAssignments
3541
+ - reservedIpRanges
3542
+ - enabled
3543
+ type: object
3544
+ properties:
3545
+ id:
3546
+ minLength: 1
3547
+ type: string
3548
+ networkId:
3549
+ minLength: 1
3550
+ type: string
3551
+ name:
3552
+ minLength: 1
3553
+ type: string
3554
+ gatewayIp:
3555
+ minLength: 1
3556
+ type: string
3557
+ subnet:
3558
+ minLength: 1
3559
+ type: string
3560
+ fixedIpAssignments:
3561
+ minLength: 1
3562
+ type: string
3563
+ reservedIpRanges:
3564
+ minLength: 1
3565
+ type: string
3566
+ enabled:
3567
+ type: boolean
3568
+ updateNetworkStaticRouteResponse:
3569
+ title: updateNetworkStaticRouteResponse
3570
+ required:
3571
+ - id
3572
+ - networkId
3573
+ - name
3574
+ - gatewayIp
3575
+ - subnet
3576
+ - fixedIpAssignments
3577
+ - reservedIpRanges
3578
+ - enabled
3579
+ type: object
3580
+ properties:
3581
+ id:
3582
+ minLength: 1
3583
+ type: string
3584
+ networkId:
3585
+ minLength: 1
3586
+ type: string
3587
+ name:
3588
+ minLength: 1
3589
+ type: string
3590
+ gatewayIp:
3591
+ minLength: 1
3592
+ type: string
3593
+ subnet:
3594
+ minLength: 1
3595
+ type: string
3596
+ fixedIpAssignments:
3597
+ minLength: 1
3598
+ type: string
3599
+ reservedIpRanges:
3600
+ minLength: 1
3601
+ type: string
3602
+ enabled:
3603
+ type: boolean
3604
+ getNetworkNetflowSettingsResponse:
3605
+ title: getNetworkNetflowSettingsResponse
3606
+ required:
3607
+ - reportingEnabled
3608
+ - collectorIp
3609
+ - collectorPort
3610
+ type: object
3611
+ properties:
3612
+ reportingEnabled:
3613
+ type: boolean
3614
+ collectorIp:
3615
+ minLength: 1
3616
+ type: string
3617
+ collectorPort:
3618
+ type: number
3619
+ updateNetworkNetflowSettingsResponse:
3620
+ title: updateNetworkNetflowSettingsResponse
3621
+ required:
3622
+ - reportingEnabled
3623
+ - collectorIp
3624
+ - collectorPort
3625
+ type: object
3626
+ properties:
3627
+ reportingEnabled:
3628
+ type: boolean
3629
+ collectorIp:
3630
+ minLength: 1
3631
+ type: string
3632
+ collectorPort:
3633
+ type: number
3634
+ getNetworkTrafficAnalysisSettingsResponse:
3635
+ title: getNetworkTrafficAnalysisSettingsResponse
3636
+ required:
3637
+ - mode
3638
+ - customPieChartItems
3639
+ type: object
3640
+ properties:
3641
+ mode:
3642
+ minLength: 1
3643
+ type: string
3644
+ customPieChartItems:
3645
+ minItems: 1
3646
+ uniqueItems: true
3647
+ type: array
3648
+ items:
3649
+ $ref: '#/components/schemas/CustomPieChartItem'
3650
+ description: ''
3651
+ CustomPieChartItem:
3652
+ title: CustomPieChartItem
3653
+ required:
3654
+ - name
3655
+ - type
3656
+ - value
3657
+ type: object
3658
+ properties:
3659
+ name:
3660
+ minLength: 1
3661
+ type: string
3662
+ type:
3663
+ minLength: 1
3664
+ type: string
3665
+ value:
3666
+ minLength: 1
3667
+ type: string
3668
+ updateNetworkTrafficAnalysisSettingsResponse:
3669
+ title: updateNetworkTrafficAnalysisSettingsResponse
3670
+ required:
3671
+ - mode
3672
+ - customPieChartItems
3673
+ type: object
3674
+ properties:
3675
+ mode:
3676
+ minLength: 1
3677
+ type: string
3678
+ customPieChartItems:
3679
+ minItems: 1
3680
+ uniqueItems: true
3681
+ type: array
3682
+ items:
3683
+ $ref: '#/components/schemas/CustomPieChartItem'
3684
+ description: ''
3685
+ getOrganizationWebhookLogsResponse:
3686
+ title: getOrganizationWebhookLogsResponse
3687
+ required:
3688
+ - organizationId
3689
+ - networkId
3690
+ - alertType
3691
+ - url
3692
+ - sentAt
3693
+ - loggedAt
3694
+ - responseCode
3695
+ - responseDuration
3696
+ type: object
3697
+ properties:
3698
+ organizationId:
3699
+ minLength: 1
3700
+ type: string
3701
+ networkId:
3702
+ minLength: 1
3703
+ type: string
3704
+ alertType:
3705
+ minLength: 1
3706
+ type: string
3707
+ url:
3708
+ minLength: 1
3709
+ type: string
3710
+ sentAt:
3711
+ minLength: 1
3712
+ type: string
3713
+ loggedAt:
3714
+ minLength: 1
3715
+ type: string
3716
+ responseCode:
3717
+ type: number
3718
+ responseDuration:
3719
+ type: number
3720
+ getNetworkWirelessSettingsResponse:
3721
+ title: getNetworkWirelessSettingsResponse
3722
+ required:
3723
+ - meshingEnabled
3724
+ - ipv6BridgeEnabled
3725
+ - locationAnalyticsEnabled
3726
+ type: object
3727
+ properties:
3728
+ meshingEnabled:
3729
+ type: boolean
3730
+ ipv6BridgeEnabled:
3731
+ type: boolean
3732
+ locationAnalyticsEnabled:
3733
+ type: boolean
3734
+ updateNetworkWirelessSettingsResponse:
3735
+ title: updateNetworkWirelessSettingsResponse
3736
+ required:
3737
+ - meshingEnabled
3738
+ - ipv6BridgeEnabled
3739
+ - locationAnalyticsEnabled
3740
+ type: object
3741
+ properties:
3742
+ meshingEnabled:
3743
+ type: boolean
3744
+ ipv6BridgeEnabled:
3745
+ type: boolean
3746
+ locationAnalyticsEnabled:
3747
+ type: boolean
3748
+ tags:
3749
+ - name: CameraQualityRetentionProfiles
3750
+ - name: MGConnectivityMonitoringDestinations
3751
+ - name: MGDHCPSettings
3752
+ - name: MGLANSettings
3753
+ - name: MGPortforwardingRules
3754
+ - name: MGSubnetPoolSettings
3755
+ - name: MGUplinkSettings
3756
+ - name: SwitchACLs
3757
+ - name: SwitchPortsSchedules
3758
+ - name: MXVLANPorts
3759
+ - name: MXWarmSpareSettings
3760
+ - name: Licenses
3761
+ - name: SwitchSettings
3762
+ - name: ConnectivityMonitoringDestinations
3763
+ - name: DashboardBrandingPolicies
3764
+ - name: Events
3765
+ - name: Floorplans
3766
+ - name: LinkAggregations
3767
+ - name: MXStaticRoutes
3768
+ - name: NetFlowSettings
3769
+ - name: TrafficAnalysisSettings
3770
+ - name: WebhookLogs
3771
+ - name: WirelessSettings
3772
+ externalDocs:
3773
+ description: Find out more about Swagger
3774
+ url: http://swagger.io