@itentialopensource/adapter-phpipam 2.1.0 → 2.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CALLS.md +588 -0
  2. package/CHANGELOG.md +16 -0
  3. package/CONTRIBUTING.md +1 -160
  4. package/ENHANCE.md +2 -2
  5. package/README.md +32 -23
  6. package/adapter.js +157 -329
  7. package/adapterBase.js +549 -879
  8. package/changelogs/changelog.md +102 -0
  9. package/metadata.json +49 -0
  10. package/package.json +24 -25
  11. package/pronghorn.json +981 -642
  12. package/propertiesSchema.json +431 -31
  13. package/refs?service=git-upload-pack +0 -0
  14. package/report/adapter-openapi.json +4152 -0
  15. package/report/adapter-openapi.yaml +3011 -0
  16. package/report/adapterInfo.json +8 -8
  17. package/report/updateReport1691508486949.json +120 -0
  18. package/report/updateReport1692202972871.json +120 -0
  19. package/report/updateReport1694466392520.json +120 -0
  20. package/report/updateReport1698421952447.json +120 -0
  21. package/sampleProperties.json +63 -2
  22. package/test/integration/adapterTestBasicGet.js +2 -4
  23. package/test/integration/adapterTestConnectivity.js +91 -42
  24. package/test/integration/adapterTestIntegration.js +130 -2
  25. package/test/unit/adapterBaseTestUnit.js +388 -313
  26. package/test/unit/adapterTestUnit.js +338 -112
  27. package/utils/adapterInfo.js +1 -1
  28. package/utils/addAuth.js +1 -1
  29. package/utils/artifactize.js +1 -1
  30. package/utils/checkMigrate.js +1 -1
  31. package/utils/entitiesToDB.js +2 -2
  32. package/utils/findPath.js +1 -1
  33. package/utils/methodDocumentor.js +273 -0
  34. package/utils/modify.js +13 -15
  35. package/utils/packModificationScript.js +1 -1
  36. package/utils/pre-commit.sh +2 -0
  37. package/utils/taskMover.js +309 -0
  38. package/utils/tbScript.js +89 -34
  39. package/utils/tbUtils.js +41 -21
  40. package/utils/testRunner.js +1 -1
  41. package/utils/troubleshootingAdapter.js +9 -6
  42. package/workflows/README.md +0 -3
@@ -0,0 +1,3011 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: phpipam
4
+ description: Open-source IP address management
5
+ contact:
6
+ email: apiteam@swagger.io
7
+ version: '1.0.0'
8
+ servers:
9
+ - url: https://your.host.name.io/api
10
+ variables: {}
11
+ - url: http://your.host.name.io/api
12
+ variables: {}
13
+ paths:
14
+ /sections:
15
+ get:
16
+ tags:
17
+ - sections
18
+ summary: getSections
19
+ description: Returns all sections
20
+ operationId: getSections
21
+ parameters: []
22
+ responses:
23
+ '200':
24
+ description: successful operation
25
+ headers: {}
26
+ content:
27
+ text/plain:
28
+ schema:
29
+ type: string
30
+ description: successful operation
31
+ '400':
32
+ description: failed operation
33
+ headers: {}
34
+ content: {}
35
+ deprecated: false
36
+ post:
37
+ tags:
38
+ - sections
39
+ summary: createSection
40
+ description: Creates new section
41
+ operationId: createSection
42
+ parameters: []
43
+ requestBody:
44
+ description: body
45
+ content:
46
+ text/plain:
47
+ schema:
48
+ type: string
49
+ description: body
50
+ required: false
51
+ responses:
52
+ '200':
53
+ description: successful operation
54
+ headers: {}
55
+ content:
56
+ text/plain:
57
+ schema:
58
+ type: string
59
+ description: successful operation
60
+ '400':
61
+ description: failed operation
62
+ headers: {}
63
+ content: {}
64
+ deprecated: false
65
+ patch:
66
+ tags:
67
+ - sections
68
+ summary: updateSection
69
+ description: Updates section
70
+ operationId: updateSection
71
+ parameters: []
72
+ requestBody:
73
+ description: body
74
+ content:
75
+ text/plain:
76
+ schema:
77
+ type: string
78
+ description: body
79
+ required: false
80
+ responses:
81
+ '200':
82
+ description: successful operation
83
+ headers: {}
84
+ content:
85
+ text/plain:
86
+ schema:
87
+ type: string
88
+ description: successful operation
89
+ '400':
90
+ description: failed operation
91
+ headers: {}
92
+ content: {}
93
+ deprecated: false
94
+ /sections/{id}:
95
+ get:
96
+ tags:
97
+ - sections
98
+ summary: getSection
99
+ description: Returns specific section
100
+ operationId: getSection
101
+ parameters:
102
+ - name: id
103
+ in: path
104
+ description: Section identifier, identifies which section to work on.
105
+ required: true
106
+ style: simple
107
+ schema:
108
+ type: string
109
+ responses:
110
+ '200':
111
+ description: successful operation
112
+ headers: {}
113
+ content:
114
+ text/plain:
115
+ schema:
116
+ type: string
117
+ description: successful operation
118
+ '400':
119
+ description: failed operation
120
+ headers: {}
121
+ content: {}
122
+ deprecated: false
123
+ delete:
124
+ tags:
125
+ - sections
126
+ summary: deleteSection
127
+ description: Deletes section with all belonging subnets and addresses
128
+ operationId: deleteSection
129
+ parameters:
130
+ - name: id
131
+ in: path
132
+ description: Section identifier, identifies which section to work on.
133
+ required: true
134
+ style: simple
135
+ schema:
136
+ type: string
137
+ responses:
138
+ '200':
139
+ description: successful operation
140
+ headers: {}
141
+ content:
142
+ text/plain:
143
+ schema:
144
+ type: string
145
+ description: successful operation
146
+ '400':
147
+ description: failed operation
148
+ headers: {}
149
+ content: {}
150
+ deprecated: false
151
+ /sections/{id}/subnets:
152
+ get:
153
+ tags:
154
+ - sections
155
+ summary: getSectionSubnets
156
+ description: Returns all subnets in section
157
+ operationId: getSectionSubnets
158
+ parameters:
159
+ - name: id
160
+ in: path
161
+ description: Section identifier, identifies which section to work on.
162
+ required: true
163
+ style: simple
164
+ schema:
165
+ type: string
166
+ responses:
167
+ '200':
168
+ description: successful operation
169
+ headers: {}
170
+ content:
171
+ text/plain:
172
+ schema:
173
+ type: string
174
+ description: successful operation
175
+ '400':
176
+ description: failed operation
177
+ headers: {}
178
+ content: {}
179
+ deprecated: false
180
+ /sections/{name}:
181
+ get:
182
+ tags:
183
+ - sections
184
+ summary: getSectionByName
185
+ description: Returns specific section by name
186
+ operationId: getSectionByName
187
+ parameters:
188
+ - name: name
189
+ in: path
190
+ description: Section name, unique value
191
+ required: true
192
+ style: simple
193
+ schema:
194
+ type: string
195
+ responses:
196
+ '200':
197
+ description: successful operation
198
+ headers: {}
199
+ content:
200
+ text/plain:
201
+ schema:
202
+ type: string
203
+ description: successful operation
204
+ '400':
205
+ description: failed operation
206
+ headers: {}
207
+ content: {}
208
+ deprecated: false
209
+ /sections/custom_fields:
210
+ get:
211
+ tags:
212
+ - sections
213
+ summary: getSectionsCustomFields
214
+ description: Returns custom section fields
215
+ operationId: getSectionsCustomFields
216
+ parameters: []
217
+ responses:
218
+ '200':
219
+ description: successful operation
220
+ headers: {}
221
+ content:
222
+ text/plain:
223
+ schema:
224
+ type: string
225
+ description: successful operation
226
+ '400':
227
+ description: failed operation
228
+ headers: {}
229
+ content: {}
230
+ deprecated: false
231
+ /subnets/{id}:
232
+ get:
233
+ tags:
234
+ - subnets
235
+ summary: getSubnet
236
+ description: Returns specific subnet by id
237
+ operationId: getSubnet
238
+ parameters:
239
+ - name: id
240
+ in: path
241
+ description: Subnet identifier, identifies which subnetto work on.
242
+ required: true
243
+ style: simple
244
+ schema:
245
+ type: string
246
+ responses:
247
+ '200':
248
+ description: successful operation
249
+ headers: {}
250
+ content:
251
+ text/plain:
252
+ schema:
253
+ type: string
254
+ description: successful operation
255
+ '400':
256
+ description: failed operation
257
+ headers: {}
258
+ content: {}
259
+ deprecated: false
260
+ delete:
261
+ tags:
262
+ - subnets
263
+ summary: deleteSubnet
264
+ description: Deletes Subnet
265
+ operationId: deleteSubnet
266
+ parameters:
267
+ - name: id
268
+ in: path
269
+ description: Subnet identifier, identifies which subnetto work on.
270
+ required: true
271
+ style: simple
272
+ schema:
273
+ type: string
274
+ responses:
275
+ '200':
276
+ description: successful operation
277
+ headers: {}
278
+ content:
279
+ text/plain:
280
+ schema:
281
+ type: string
282
+ description: successful operation
283
+ '400':
284
+ description: failed operation
285
+ headers: {}
286
+ content: {}
287
+ deprecated: false
288
+ /subnets/{id}/usage:
289
+ get:
290
+ tags:
291
+ - subnets
292
+ summary: getSubnetUsage
293
+ description: Returns subnet usage
294
+ operationId: getSubnetUsage
295
+ parameters:
296
+ - name: id
297
+ in: path
298
+ description: Subnet identifier, identifies which subnetto work on.
299
+ required: true
300
+ style: simple
301
+ schema:
302
+ type: string
303
+ responses:
304
+ '200':
305
+ description: successful operation
306
+ headers: {}
307
+ content:
308
+ text/plain:
309
+ schema:
310
+ type: string
311
+ description: successful operation
312
+ '400':
313
+ description: failed operation
314
+ headers: {}
315
+ content: {}
316
+ deprecated: false
317
+ /subnets/{id}/first_free:
318
+ get:
319
+ tags:
320
+ - subnets
321
+ summary: getSubnetFirstFree
322
+ description: Returns first available IP address in subnet
323
+ operationId: getSubnetFirstFree
324
+ parameters:
325
+ - name: id
326
+ in: path
327
+ description: Subnet identifier, identifies which subnetto work on.
328
+ required: true
329
+ style: simple
330
+ schema:
331
+ type: string
332
+ responses:
333
+ '200':
334
+ description: successful operation
335
+ headers: {}
336
+ content:
337
+ text/plain:
338
+ schema:
339
+ type: string
340
+ description: successful operation
341
+ '400':
342
+ description: failed operation
343
+ headers: {}
344
+ content: {}
345
+ deprecated: false
346
+ /subnets/{id}/slaves:
347
+ get:
348
+ tags:
349
+ - subnets
350
+ summary: getSubnetSlaves
351
+ description: Returns all immediate slave subnets
352
+ operationId: getSubnetSlaves
353
+ parameters:
354
+ - name: id
355
+ in: path
356
+ description: Subnet identifier, identifies which subnetto work on.
357
+ required: true
358
+ style: simple
359
+ schema:
360
+ type: string
361
+ responses:
362
+ '200':
363
+ description: successful operation
364
+ headers: {}
365
+ content:
366
+ text/plain:
367
+ schema:
368
+ type: string
369
+ description: successful operation
370
+ '400':
371
+ description: failed operation
372
+ headers: {}
373
+ content: {}
374
+ deprecated: false
375
+ /subnets/{id}/slaves_recursive:
376
+ get:
377
+ tags:
378
+ - subnets
379
+ summary: getSubnetSlavesRecursive
380
+ description: Returns all slave subnets recursive
381
+ operationId: getSubnetSlavesRecursive
382
+ parameters:
383
+ - name: id
384
+ in: path
385
+ description: Subnet identifier, identifies which subnetto work on.
386
+ required: true
387
+ style: simple
388
+ schema:
389
+ type: string
390
+ responses:
391
+ '200':
392
+ description: successful operation
393
+ headers: {}
394
+ content:
395
+ text/plain:
396
+ schema:
397
+ type: string
398
+ description: successful operation
399
+ '400':
400
+ description: failed operation
401
+ headers: {}
402
+ content: {}
403
+ deprecated: false
404
+ /subnets/{id}/addresses:
405
+ get:
406
+ tags:
407
+ - subnets
408
+ summary: getSubnetAddresses
409
+ description: Returns all addresses in subnet
410
+ operationId: getSubnetAddresses
411
+ parameters:
412
+ - name: id
413
+ in: path
414
+ description: Subnet identifier, identifies which subnetto work on.
415
+ required: true
416
+ style: simple
417
+ schema:
418
+ type: string
419
+ responses:
420
+ '200':
421
+ description: successful operation
422
+ headers: {}
423
+ content:
424
+ text/plain:
425
+ schema:
426
+ type: string
427
+ description: successful operation
428
+ '400':
429
+ description: failed operation
430
+ headers: {}
431
+ content: {}
432
+ deprecated: false
433
+ /subnets/{id}/addresses/{ip}:
434
+ get:
435
+ tags:
436
+ - subnets
437
+ summary: getSubnetIPAddress
438
+ description: Returns IP address from subnet
439
+ operationId: getSubnetIPAddress
440
+ parameters:
441
+ - name: id
442
+ in: path
443
+ description: Subnet identifier, identifies which subnetto work on.
444
+ required: true
445
+ style: simple
446
+ schema:
447
+ type: string
448
+ - name: ip
449
+ in: path
450
+ description: IP address of subnet in dotted format (e.g. 10.10.10.0)
451
+ required: true
452
+ style: simple
453
+ schema:
454
+ type: string
455
+ responses:
456
+ '200':
457
+ description: successful operation
458
+ headers: {}
459
+ content:
460
+ text/plain:
461
+ schema:
462
+ type: string
463
+ description: successful operation
464
+ '400':
465
+ description: failed operation
466
+ headers: {}
467
+ content: {}
468
+ deprecated: false
469
+ /subnets/{id}/first_subnet/{mask}:
470
+ get:
471
+ tags:
472
+ - subnets
473
+ summary: getSubnetFirstAvailable
474
+ description: Returns first available subnet within selected for mask
475
+ operationId: getSubnetFirstAvailable
476
+ parameters:
477
+ - name: id
478
+ in: path
479
+ description: Subnet identifier, identifies which subnetto work on.
480
+ required: true
481
+ style: simple
482
+ schema:
483
+ type: string
484
+ - name: mask
485
+ in: path
486
+ description: Subnet bitmask
487
+ required: true
488
+ style: simple
489
+ schema:
490
+ type: string
491
+ responses:
492
+ '200':
493
+ description: successful operation
494
+ headers: {}
495
+ content:
496
+ text/plain:
497
+ schema:
498
+ type: string
499
+ description: successful operation
500
+ '400':
501
+ description: failed operation
502
+ headers: {}
503
+ content: {}
504
+ deprecated: false
505
+ post:
506
+ tags:
507
+ - subnets
508
+ summary: createSubnetInsideSubnet
509
+ description: Creates new child subnet inside subnet with specified mask
510
+ operationId: createSubnetInsideSubnet
511
+ parameters:
512
+ - name: id
513
+ in: path
514
+ description: ''
515
+ required: true
516
+ style: simple
517
+ schema:
518
+ type: string
519
+ - name: mask
520
+ in: path
521
+ description: ''
522
+ required: true
523
+ style: simple
524
+ schema:
525
+ type: string
526
+ requestBody:
527
+ description: body
528
+ content:
529
+ text/plain:
530
+ schema:
531
+ type: string
532
+ description: body
533
+ required: false
534
+ responses:
535
+ '200':
536
+ description: successful operation
537
+ headers: {}
538
+ content:
539
+ text/plain:
540
+ schema:
541
+ type: string
542
+ description: successful operation
543
+ '400':
544
+ description: failed operation
545
+ headers: {}
546
+ content: {}
547
+ deprecated: false
548
+ /subnets/{id}/all_subnets/{mask}:
549
+ get:
550
+ tags:
551
+ - subnets
552
+ summary: getSubnetAllAvailable
553
+ description: Returns all available subnets within selected for mask
554
+ operationId: getSubnetAllAvailable
555
+ parameters:
556
+ - name: id
557
+ in: path
558
+ description: Subnet identifier, identifies which subnetto work on
559
+ required: true
560
+ style: simple
561
+ schema:
562
+ type: string
563
+ - name: mask
564
+ in: path
565
+ description: Subnet bitmask
566
+ required: true
567
+ style: simple
568
+ schema:
569
+ type: string
570
+ responses:
571
+ '200':
572
+ description: successful operation
573
+ headers: {}
574
+ content:
575
+ text/plain:
576
+ schema:
577
+ type: string
578
+ description: successful operation
579
+ '400':
580
+ description: failed operation
581
+ headers: {}
582
+ content: {}
583
+ deprecated: false
584
+ /subnets/custom_fields:
585
+ get:
586
+ tags:
587
+ - subnets
588
+ summary: getSubnetCustomFields
589
+ description: Returns all subnet custom fields
590
+ operationId: getSubnetCustomFields
591
+ parameters: []
592
+ responses:
593
+ '200':
594
+ description: successful operation
595
+ headers: {}
596
+ content:
597
+ text/plain:
598
+ schema:
599
+ type: string
600
+ description: successful operation
601
+ '400':
602
+ description: failed operation
603
+ headers: {}
604
+ content: {}
605
+ deprecated: false
606
+ /subnets/cidr/{subnet}:
607
+ get:
608
+ tags:
609
+ - subnets
610
+ summary: getSubnetCIDR
611
+ description: Searches for subnet in CIDR format
612
+ operationId: getSubnetCIDR
613
+ parameters:
614
+ - name: subnet
615
+ in: path
616
+ description: IP address of subnet in dotted format (e.g. 10.10.10.0)
617
+ required: true
618
+ style: simple
619
+ schema:
620
+ type: string
621
+ responses:
622
+ '200':
623
+ description: successful operation
624
+ headers: {}
625
+ content:
626
+ text/plain:
627
+ schema:
628
+ type: string
629
+ description: successful operation
630
+ '400':
631
+ description: failed operation
632
+ headers: {}
633
+ content: {}
634
+ deprecated: false
635
+ /subnets/search/{subnet}:
636
+ get:
637
+ tags:
638
+ - subnets
639
+ summary: getSubnetCIDRSearch
640
+ description: Searches for subnet in CIDR format
641
+ operationId: getSubnetCIDRSearch
642
+ parameters:
643
+ - name: subnet
644
+ in: path
645
+ description: IP address of subnet in dotted format (e.g. 10.10.10.0)
646
+ required: true
647
+ style: simple
648
+ schema:
649
+ type: string
650
+ responses:
651
+ '200':
652
+ description: successful operation
653
+ headers: {}
654
+ content:
655
+ text/plain:
656
+ schema:
657
+ type: string
658
+ description: successful operation
659
+ '400':
660
+ description: failed operation
661
+ headers: {}
662
+ content: {}
663
+ deprecated: false
664
+ /subnets:
665
+ post:
666
+ tags:
667
+ - subnets
668
+ summary: createSubnet
669
+ description: Creates new subnet
670
+ operationId: createSubnet
671
+ parameters: []
672
+ requestBody:
673
+ description: body
674
+ content:
675
+ text/plain:
676
+ schema:
677
+ type: string
678
+ description: body
679
+ required: false
680
+ responses:
681
+ '200':
682
+ description: successful operation
683
+ headers: {}
684
+ content:
685
+ text/plain:
686
+ schema:
687
+ type: string
688
+ description: successful operation
689
+ '400':
690
+ description: failed operation
691
+ headers: {}
692
+ content: {}
693
+ deprecated: false
694
+ patch:
695
+ tags:
696
+ - subnets
697
+ summary: updateSubnet
698
+ description: Updates Subnet
699
+ operationId: updateSubnet
700
+ parameters: []
701
+ requestBody:
702
+ description: body
703
+ content:
704
+ text/plain:
705
+ schema:
706
+ type: string
707
+ description: body
708
+ required: false
709
+ responses:
710
+ '200':
711
+ description: successful operation
712
+ headers: {}
713
+ content:
714
+ text/plain:
715
+ schema:
716
+ type: string
717
+ description: successful operation
718
+ '400':
719
+ description: failed operation
720
+ headers: {}
721
+ content: {}
722
+ deprecated: false
723
+ /subnets/{id}/resize:
724
+ patch:
725
+ tags:
726
+ - subnets
727
+ summary: updateSubnetMaskSize
728
+ description: Resizes subnet to new mask
729
+ operationId: updateSubnetMaskSize
730
+ parameters:
731
+ - name: id
732
+ in: path
733
+ description: Subnet identifier, identifies which subnetto work on.
734
+ required: true
735
+ style: simple
736
+ schema:
737
+ type: string
738
+ requestBody:
739
+ description: body
740
+ content:
741
+ text/plain:
742
+ schema:
743
+ type: string
744
+ description: body
745
+ required: false
746
+ responses:
747
+ '200':
748
+ description: successful operation
749
+ headers: {}
750
+ content:
751
+ text/plain:
752
+ schema:
753
+ type: string
754
+ description: successful operation
755
+ '400':
756
+ description: failed operation
757
+ headers: {}
758
+ content: {}
759
+ deprecated: false
760
+ /subnets/{id}/split:
761
+ patch:
762
+ tags:
763
+ - subnets
764
+ summary: updateSubnetSplit
765
+ description: Splits subnet to smaller subnets
766
+ operationId: updateSubnetSplit
767
+ parameters:
768
+ - name: id
769
+ in: path
770
+ description: Subnet identifier, identifies which subnetto work on.
771
+ required: true
772
+ style: simple
773
+ schema:
774
+ type: string
775
+ requestBody:
776
+ description: body
777
+ content:
778
+ text/plain:
779
+ schema:
780
+ type: string
781
+ description: body
782
+ required: false
783
+ responses:
784
+ '200':
785
+ description: successful operation
786
+ headers: {}
787
+ content:
788
+ text/plain:
789
+ schema:
790
+ type: string
791
+ description: successful operation
792
+ '400':
793
+ description: failed operation
794
+ headers: {}
795
+ content: {}
796
+ deprecated: false
797
+ /subnets/{id}/permissions:
798
+ patch:
799
+ tags:
800
+ - subnets
801
+ summary: udpateSubnetPermissions
802
+ description: Sets subnet permissions (?grouname1=ro&groupname2=3&43=1)
803
+ operationId: udpateSubnetPermissions
804
+ parameters:
805
+ - name: id
806
+ in: path
807
+ description: Subnet identifier, identifies which subnetto work on.
808
+ required: true
809
+ style: simple
810
+ schema:
811
+ type: string
812
+ requestBody:
813
+ description: body
814
+ content:
815
+ text/plain:
816
+ schema:
817
+ type: string
818
+ description: body
819
+ required: false
820
+ responses:
821
+ '200':
822
+ description: successful operation
823
+ headers: {}
824
+ content:
825
+ text/plain:
826
+ schema:
827
+ type: string
828
+ description: successful operation
829
+ '400':
830
+ description: failed operation
831
+ headers: {}
832
+ content: {}
833
+ deprecated: false
834
+ delete:
835
+ tags:
836
+ - subnets
837
+ summary: deleteSubnetPermissions
838
+ description: Removes all permissions
839
+ operationId: deleteSubnetPermissions
840
+ parameters:
841
+ - name: id
842
+ in: path
843
+ description: Subnet identifier, identifies which subnetto work on.
844
+ required: true
845
+ style: simple
846
+ schema:
847
+ type: string
848
+ responses:
849
+ '200':
850
+ description: successful operation
851
+ headers: {}
852
+ content:
853
+ text/plain:
854
+ schema:
855
+ type: string
856
+ description: successful operation
857
+ '400':
858
+ description: failed operation
859
+ headers: {}
860
+ content: {}
861
+ deprecated: false
862
+ /subnets/{id}/truncate:
863
+ delete:
864
+ tags:
865
+ - subnets
866
+ summary: deleteSubnetAddresses
867
+ description: Removes all addresses from subnet
868
+ operationId: deleteSubnetAddresses
869
+ parameters:
870
+ - name: id
871
+ in: path
872
+ description: Subnet identifier, identifies which subnetto work on.
873
+ required: true
874
+ style: simple
875
+ schema:
876
+ type: string
877
+ responses:
878
+ '200':
879
+ description: successful operation
880
+ headers: {}
881
+ content:
882
+ text/plain:
883
+ schema:
884
+ type: string
885
+ description: successful operation
886
+ '400':
887
+ description: failed operation
888
+ headers: {}
889
+ content: {}
890
+ deprecated: false
891
+ /devices:
892
+ get:
893
+ tags:
894
+ - devices
895
+ summary: getDevices
896
+ description: Returns all devices
897
+ operationId: getDevices
898
+ parameters: []
899
+ responses:
900
+ '200':
901
+ description: successful operation
902
+ headers: {}
903
+ content:
904
+ text/plain:
905
+ schema:
906
+ type: string
907
+ description: successful operation
908
+ '400':
909
+ description: failed operation
910
+ headers: {}
911
+ content: {}
912
+ deprecated: false
913
+ post:
914
+ tags:
915
+ - devices
916
+ summary: createDevice
917
+ description: Creates new device
918
+ operationId: createDevice
919
+ parameters: []
920
+ requestBody:
921
+ description: body
922
+ content:
923
+ text/plain:
924
+ schema:
925
+ type: string
926
+ description: body
927
+ required: false
928
+ responses:
929
+ '200':
930
+ description: successful operation
931
+ headers: {}
932
+ content:
933
+ text/plain:
934
+ schema:
935
+ type: string
936
+ description: successful operation
937
+ '400':
938
+ description: failed operation
939
+ headers: {}
940
+ content: {}
941
+ deprecated: false
942
+ patch:
943
+ tags:
944
+ - devices
945
+ summary: updateDevice
946
+ description: Updates device
947
+ operationId: updateDevice
948
+ parameters: []
949
+ requestBody:
950
+ description: body
951
+ content:
952
+ text/plain:
953
+ schema:
954
+ type: string
955
+ description: body
956
+ required: false
957
+ responses:
958
+ '200':
959
+ description: successful operation
960
+ headers: {}
961
+ content:
962
+ text/plain:
963
+ schema:
964
+ type: string
965
+ description: successful operation
966
+ '400':
967
+ description: failed operation
968
+ headers: {}
969
+ content: {}
970
+ deprecated: false
971
+ /devices/{id}:
972
+ get:
973
+ tags:
974
+ - devices
975
+ summary: getDevice
976
+ description: Returns specific device
977
+ operationId: getDevice
978
+ parameters:
979
+ - name: id
980
+ in: path
981
+ description: Device identifier
982
+ required: true
983
+ style: simple
984
+ schema:
985
+ type: string
986
+ responses:
987
+ '200':
988
+ description: successful operation
989
+ headers: {}
990
+ content:
991
+ text/plain:
992
+ schema:
993
+ type: string
994
+ description: successful operation
995
+ '400':
996
+ description: failed operation
997
+ headers: {}
998
+ content: {}
999
+ deprecated: false
1000
+ delete:
1001
+ tags:
1002
+ - devices
1003
+ summary: deleteDevice
1004
+ description: Deletes device
1005
+ operationId: deleteDevice
1006
+ parameters:
1007
+ - name: id
1008
+ in: path
1009
+ description: Device identifier
1010
+ required: true
1011
+ style: simple
1012
+ schema:
1013
+ type: string
1014
+ responses:
1015
+ '200':
1016
+ description: successful operation
1017
+ headers: {}
1018
+ content:
1019
+ text/plain:
1020
+ schema:
1021
+ type: string
1022
+ description: successful operation
1023
+ '400':
1024
+ description: failed operation
1025
+ headers: {}
1026
+ content: {}
1027
+ deprecated: false
1028
+ /devices/{id}/subnets:
1029
+ get:
1030
+ tags:
1031
+ - devices
1032
+ summary: getDeviceSubnets
1033
+ description: Returns all subnets within device
1034
+ operationId: getDeviceSubnets
1035
+ parameters:
1036
+ - name: id
1037
+ in: path
1038
+ description: Device identifier
1039
+ required: true
1040
+ style: simple
1041
+ schema:
1042
+ type: string
1043
+ responses:
1044
+ '200':
1045
+ description: successful operation
1046
+ headers: {}
1047
+ content:
1048
+ text/plain:
1049
+ schema:
1050
+ type: string
1051
+ description: successful operation
1052
+ '400':
1053
+ description: failed operation
1054
+ headers: {}
1055
+ content: {}
1056
+ deprecated: false
1057
+ /devices/{id}/addresses:
1058
+ get:
1059
+ tags:
1060
+ - devices
1061
+ summary: getDeviceAddresses
1062
+ description: Returns all addresses within device
1063
+ operationId: getDeviceAddresses
1064
+ parameters:
1065
+ - name: id
1066
+ in: path
1067
+ description: Device identifier
1068
+ required: true
1069
+ style: simple
1070
+ schema:
1071
+ type: string
1072
+ responses:
1073
+ '200':
1074
+ description: successful operation
1075
+ headers: {}
1076
+ content:
1077
+ text/plain:
1078
+ schema:
1079
+ type: string
1080
+ description: successful operation
1081
+ '400':
1082
+ description: failed operation
1083
+ headers: {}
1084
+ content: {}
1085
+ deprecated: false
1086
+ /devices/search/{search_string}:
1087
+ get:
1088
+ tags:
1089
+ - devices
1090
+ summary: getDevicesBySearchString
1091
+ description: Searches for devices with {search_string} in any belonging field
1092
+ operationId: getDevicesBySearchString
1093
+ parameters:
1094
+ - name: search_string
1095
+ in: path
1096
+ description: search string
1097
+ required: true
1098
+ style: simple
1099
+ schema:
1100
+ type: string
1101
+ responses:
1102
+ '200':
1103
+ description: successful operation
1104
+ headers: {}
1105
+ content:
1106
+ text/plain:
1107
+ schema:
1108
+ type: string
1109
+ description: successful operation
1110
+ '400':
1111
+ description: failed operation
1112
+ headers: {}
1113
+ content: {}
1114
+ deprecated: false
1115
+ /addresses/{id}:
1116
+ get:
1117
+ tags:
1118
+ - addresses
1119
+ summary: getAddress
1120
+ description: Returns specific address
1121
+ operationId: getAddress
1122
+ parameters:
1123
+ - name: id
1124
+ in: path
1125
+ description: address identifier, identifies which addressto work on.
1126
+ required: true
1127
+ style: simple
1128
+ schema:
1129
+ type: string
1130
+ responses:
1131
+ '200':
1132
+ description: successful operation
1133
+ headers: {}
1134
+ content:
1135
+ text/plain:
1136
+ schema:
1137
+ type: string
1138
+ description: successful operation
1139
+ '400':
1140
+ description: failed operation
1141
+ headers: {}
1142
+ content: {}
1143
+ deprecated: false
1144
+ patch:
1145
+ tags:
1146
+ - addresses
1147
+ summary: updateAddress
1148
+ description: Updates address
1149
+ operationId: updateAddress
1150
+ parameters:
1151
+ - name: id
1152
+ in: path
1153
+ description: ''
1154
+ required: true
1155
+ style: simple
1156
+ schema:
1157
+ type: string
1158
+ requestBody:
1159
+ description: body
1160
+ content:
1161
+ text/plain:
1162
+ schema:
1163
+ type: string
1164
+ description: body
1165
+ required: false
1166
+ responses:
1167
+ '200':
1168
+ description: successful operation
1169
+ headers: {}
1170
+ content:
1171
+ text/plain:
1172
+ schema:
1173
+ type: string
1174
+ description: successful operation
1175
+ '400':
1176
+ description: failed operation
1177
+ headers: {}
1178
+ content: {}
1179
+ deprecated: false
1180
+ delete:
1181
+ tags:
1182
+ - addresses
1183
+ summary: deleteAddress
1184
+ description: Deletes address - use 'remove_dns=1' parameter to remove all related DNS records
1185
+ operationId: deleteAddress
1186
+ parameters:
1187
+ - name: id
1188
+ in: path
1189
+ description: id
1190
+ required: true
1191
+ style: simple
1192
+ schema:
1193
+ type: string
1194
+ responses:
1195
+ '200':
1196
+ description: successful operation
1197
+ headers: {}
1198
+ content:
1199
+ text/plain:
1200
+ schema:
1201
+ type: string
1202
+ description: successful operation
1203
+ '400':
1204
+ description: failed operation
1205
+ headers: {}
1206
+ content: {}
1207
+ deprecated: false
1208
+ /addresses/{id}/ping:
1209
+ get:
1210
+ tags:
1211
+ - addresses
1212
+ summary: getAddressStatus
1213
+ description: Checks address status
1214
+ operationId: getAddressStatus
1215
+ parameters:
1216
+ - name: id
1217
+ in: path
1218
+ description: address identifier, identifies which addressto work on.
1219
+ required: true
1220
+ style: simple
1221
+ schema:
1222
+ type: string
1223
+ responses:
1224
+ '200':
1225
+ description: successful operation
1226
+ headers: {}
1227
+ content:
1228
+ text/plain:
1229
+ schema:
1230
+ type: string
1231
+ description: successful operation
1232
+ '400':
1233
+ description: failed operation
1234
+ headers: {}
1235
+ content: {}
1236
+ deprecated: false
1237
+ /addresses/{ip}/{subnetId}:
1238
+ get:
1239
+ tags:
1240
+ - addresses
1241
+ summary: getAddressFromSubnet
1242
+ description: Returns address from subnet by ip address
1243
+ operationId: getAddressFromSubnet
1244
+ parameters:
1245
+ - name: ip
1246
+ in: path
1247
+ description: IP address
1248
+ required: true
1249
+ style: simple
1250
+ schema:
1251
+ type: string
1252
+ - name: subnetId
1253
+ in: path
1254
+ description: Id of subnet address belongs to
1255
+ required: true
1256
+ style: simple
1257
+ schema:
1258
+ type: string
1259
+ responses:
1260
+ '200':
1261
+ description: successful operation
1262
+ headers: {}
1263
+ content:
1264
+ text/plain:
1265
+ schema:
1266
+ type: string
1267
+ description: successful operation
1268
+ '400':
1269
+ description: failed operation
1270
+ headers: {}
1271
+ content: {}
1272
+ deprecated: false
1273
+ delete:
1274
+ tags:
1275
+ - addresses
1276
+ summary: deleteAddressInSubnet
1277
+ description: Deletes address by IP in specific subnet
1278
+ operationId: deleteAddressInSubnet
1279
+ parameters:
1280
+ - name: ip
1281
+ in: path
1282
+ description: IP address
1283
+ required: true
1284
+ style: simple
1285
+ schema:
1286
+ type: string
1287
+ - name: subnetId
1288
+ in: path
1289
+ description: Id of subnet address belongs to
1290
+ required: true
1291
+ style: simple
1292
+ schema:
1293
+ type: string
1294
+ responses:
1295
+ '200':
1296
+ description: successful operation
1297
+ headers: {}
1298
+ content:
1299
+ text/plain:
1300
+ schema:
1301
+ type: string
1302
+ description: successful operation
1303
+ '400':
1304
+ description: failed operation
1305
+ headers: {}
1306
+ content: {}
1307
+ deprecated: false
1308
+ /addresses/search/{ip}:
1309
+ get:
1310
+ tags:
1311
+ - addresses
1312
+ summary: getAddressByIP
1313
+ description: searches for addresses in database, returns multiple if found
1314
+ operationId: getAddressByIP
1315
+ parameters:
1316
+ - name: ip
1317
+ in: path
1318
+ description: IP address
1319
+ required: true
1320
+ style: simple
1321
+ schema:
1322
+ type: string
1323
+ responses:
1324
+ '200':
1325
+ description: successful operation
1326
+ headers: {}
1327
+ content:
1328
+ text/plain:
1329
+ schema:
1330
+ type: string
1331
+ description: successful operation
1332
+ '400':
1333
+ description: failed operation
1334
+ headers: {}
1335
+ content: {}
1336
+ deprecated: false
1337
+ /addresses/search_hostname/{hostname}:
1338
+ get:
1339
+ tags:
1340
+ - addresses
1341
+ summary: getAddressByHostname
1342
+ description: searches for addresses in database by hostname, returns multiple if found
1343
+ operationId: getAddressByHostname
1344
+ parameters:
1345
+ - name: hostname
1346
+ in: path
1347
+ description: Address hostname
1348
+ required: true
1349
+ style: simple
1350
+ schema:
1351
+ type: string
1352
+ responses:
1353
+ '200':
1354
+ description: successful operation
1355
+ headers: {}
1356
+ content:
1357
+ text/plain:
1358
+ schema:
1359
+ type: string
1360
+ description: successful operation
1361
+ '400':
1362
+ description: failed operation
1363
+ headers: {}
1364
+ content: {}
1365
+ deprecated: false
1366
+ /addresses/first_free/{subnetId}:
1367
+ get:
1368
+ tags:
1369
+ - addresses
1370
+ summary: getAddressFirstFree
1371
+ description: Returns first available address
1372
+ operationId: getAddressFirstFree
1373
+ parameters:
1374
+ - name: subnetId
1375
+ in: path
1376
+ description: Id of subnet address belongs to
1377
+ required: true
1378
+ style: simple
1379
+ schema:
1380
+ type: string
1381
+ responses:
1382
+ '200':
1383
+ description: successful operation
1384
+ headers: {}
1385
+ content:
1386
+ text/plain:
1387
+ schema:
1388
+ type: string
1389
+ description: successful operation
1390
+ '400':
1391
+ description: failed operation
1392
+ headers: {}
1393
+ content: {}
1394
+ deprecated: false
1395
+ post:
1396
+ tags:
1397
+ - addresses
1398
+ summary: createAddressFirstAvailable
1399
+ description: Creates new address in subnets – first available
1400
+ operationId: createAddressFirstAvailable
1401
+ parameters:
1402
+ - name: subnetId
1403
+ in: path
1404
+ description: Id of subnet address belongs to
1405
+ required: true
1406
+ style: simple
1407
+ schema:
1408
+ type: string
1409
+ requestBody:
1410
+ description: body
1411
+ content:
1412
+ text/plain:
1413
+ schema:
1414
+ type: string
1415
+ description: body
1416
+ required: false
1417
+ responses:
1418
+ '200':
1419
+ description: successful operation
1420
+ headers: {}
1421
+ content:
1422
+ text/plain:
1423
+ schema:
1424
+ type: string
1425
+ description: successful operation
1426
+ '400':
1427
+ description: failed operation
1428
+ headers: {}
1429
+ content: {}
1430
+ deprecated: false
1431
+ /addresses/custom_fields:
1432
+ get:
1433
+ tags:
1434
+ - addresses
1435
+ summary: getAddressCustomFields
1436
+ description: Returns custom fields
1437
+ operationId: getAddressCustomFields
1438
+ parameters: []
1439
+ responses:
1440
+ '200':
1441
+ description: successful operation
1442
+ headers: {}
1443
+ content:
1444
+ text/plain:
1445
+ schema:
1446
+ type: string
1447
+ description: successful operation
1448
+ '400':
1449
+ description: failed operation
1450
+ headers: {}
1451
+ content: {}
1452
+ deprecated: false
1453
+ /addresses/tags:
1454
+ get:
1455
+ tags:
1456
+ - addresses
1457
+ summary: getAddressTags
1458
+ description: Returns all tags
1459
+ operationId: getAddressTags
1460
+ parameters: []
1461
+ responses:
1462
+ '200':
1463
+ description: successful operation
1464
+ headers: {}
1465
+ content:
1466
+ text/plain:
1467
+ schema:
1468
+ type: string
1469
+ description: successful operation
1470
+ '400':
1471
+ description: failed operation
1472
+ headers: {}
1473
+ content: {}
1474
+ deprecated: false
1475
+ /addresses/tags/{id}:
1476
+ get:
1477
+ tags:
1478
+ - addresses
1479
+ summary: getSpecificTag
1480
+ description: Returns specific tag
1481
+ operationId: getSpecificTag
1482
+ parameters:
1483
+ - name: id
1484
+ in: path
1485
+ description: id of tag
1486
+ required: true
1487
+ style: simple
1488
+ schema:
1489
+ type: string
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
+ '400':
1500
+ description: failed operation
1501
+ headers: {}
1502
+ content: {}
1503
+ deprecated: false
1504
+ /addresses/tags/{id}/addresses:
1505
+ get:
1506
+ tags:
1507
+ - addresses
1508
+ summary: getAddressesByTag
1509
+ description: Returns addresses for specific tag
1510
+ operationId: getAddressesByTag
1511
+ parameters:
1512
+ - name: id
1513
+ in: path
1514
+ description: id of tag
1515
+ required: true
1516
+ style: simple
1517
+ schema:
1518
+ type: string
1519
+ responses:
1520
+ '200':
1521
+ description: successful operation
1522
+ headers: {}
1523
+ content:
1524
+ text/plain:
1525
+ schema:
1526
+ type: string
1527
+ description: successful operation
1528
+ '400':
1529
+ description: failed operation
1530
+ headers: {}
1531
+ content: {}
1532
+ deprecated: false
1533
+ /addresses:
1534
+ post:
1535
+ tags:
1536
+ - addresses
1537
+ summary: createAddress
1538
+ description: Creates new address
1539
+ operationId: createAddress
1540
+ parameters: []
1541
+ requestBody:
1542
+ description: body
1543
+ content:
1544
+ text/plain:
1545
+ schema:
1546
+ type: string
1547
+ description: body
1548
+ required: false
1549
+ responses:
1550
+ '200':
1551
+ description: successful operation
1552
+ headers: {}
1553
+ content:
1554
+ text/plain:
1555
+ schema:
1556
+ type: string
1557
+ description: successful operation
1558
+ '400':
1559
+ description: failed operation
1560
+ headers: {}
1561
+ content: {}
1562
+ deprecated: false
1563
+ /vlan:
1564
+ get:
1565
+ tags:
1566
+ - vlans
1567
+ summary: getVlans
1568
+ description: Returns all Vlans
1569
+ operationId: getVlans
1570
+ parameters: []
1571
+ responses:
1572
+ '200':
1573
+ description: successful operation
1574
+ headers: {}
1575
+ content:
1576
+ text/plain:
1577
+ schema:
1578
+ type: string
1579
+ description: successful operation
1580
+ '400':
1581
+ description: failed operation
1582
+ headers: {}
1583
+ content: {}
1584
+ deprecated: false
1585
+ post:
1586
+ tags:
1587
+ - vlans
1588
+ summary: createVlan
1589
+ description: Creates new VLAN
1590
+ operationId: createVlan
1591
+ parameters: []
1592
+ requestBody:
1593
+ description: body
1594
+ content:
1595
+ text/plain:
1596
+ schema:
1597
+ type: string
1598
+ description: body
1599
+ required: false
1600
+ responses:
1601
+ '200':
1602
+ description: successful operation
1603
+ headers: {}
1604
+ content:
1605
+ text/plain:
1606
+ schema:
1607
+ type: string
1608
+ description: successful operation
1609
+ '400':
1610
+ description: failed operation
1611
+ headers: {}
1612
+ content: {}
1613
+ deprecated: false
1614
+ patch:
1615
+ tags:
1616
+ - vlans
1617
+ summary: updateVlan
1618
+ description: Updates VLAN
1619
+ operationId: updateVlan
1620
+ parameters: []
1621
+ requestBody:
1622
+ description: body
1623
+ content:
1624
+ text/plain:
1625
+ schema:
1626
+ type: string
1627
+ description: body
1628
+ required: false
1629
+ responses:
1630
+ '200':
1631
+ description: successful operation
1632
+ headers: {}
1633
+ content:
1634
+ text/plain:
1635
+ schema:
1636
+ type: string
1637
+ description: successful operation
1638
+ '400':
1639
+ description: failed operation
1640
+ headers: {}
1641
+ content: {}
1642
+ deprecated: false
1643
+ /vlan/{id}:
1644
+ get:
1645
+ tags:
1646
+ - vlans
1647
+ summary: getVlan
1648
+ description: Returns specific vlan
1649
+ operationId: getVlan
1650
+ parameters:
1651
+ - name: id
1652
+ in: path
1653
+ description: Vlan identifier, identifies which vlan to work on.
1654
+ required: true
1655
+ style: simple
1656
+ schema:
1657
+ type: string
1658
+ responses:
1659
+ '200':
1660
+ description: successful operation
1661
+ headers: {}
1662
+ content:
1663
+ text/plain:
1664
+ schema:
1665
+ type: string
1666
+ description: successful operation
1667
+ '400':
1668
+ description: failed operation
1669
+ headers: {}
1670
+ content: {}
1671
+ deprecated: false
1672
+ patch:
1673
+ tags:
1674
+ - vlans
1675
+ summary: deleteVlan
1676
+ description: Deletes VLAN
1677
+ operationId: deleteVlan
1678
+ parameters:
1679
+ - name: id
1680
+ in: path
1681
+ description: Vlan identifier, identifies which vlan to work on.
1682
+ required: true
1683
+ style: simple
1684
+ schema:
1685
+ type: string
1686
+ requestBody:
1687
+ description: body
1688
+ content:
1689
+ text/plain:
1690
+ schema:
1691
+ type: object
1692
+ description: body
1693
+ required: false
1694
+ responses:
1695
+ '200':
1696
+ description: successful operation
1697
+ headers: {}
1698
+ content:
1699
+ text/plain:
1700
+ schema:
1701
+ type: string
1702
+ description: successful operation
1703
+ '400':
1704
+ description: failed operation
1705
+ headers: {}
1706
+ content: {}
1707
+ deprecated: false
1708
+ /vlan/{id}/subnets:
1709
+ get:
1710
+ tags:
1711
+ - vlans
1712
+ summary: getVlanSubnets
1713
+ description: Returns all subnets attached to vlan
1714
+ operationId: getVlanSubnets
1715
+ parameters:
1716
+ - name: id
1717
+ in: path
1718
+ description: Vlan identifier, identifies which vlan to work on.
1719
+ required: true
1720
+ style: simple
1721
+ schema:
1722
+ type: string
1723
+ responses:
1724
+ '200':
1725
+ description: successful operation
1726
+ headers: {}
1727
+ content:
1728
+ text/plain:
1729
+ schema:
1730
+ type: string
1731
+ description: successful operation
1732
+ '400':
1733
+ description: failed operation
1734
+ headers: {}
1735
+ content: {}
1736
+ deprecated: false
1737
+ /vlan/{id}/subnets/{sectionId}:
1738
+ get:
1739
+ tags:
1740
+ - vlans
1741
+ summary: getVlanSubnetsBySection
1742
+ description: Returns all subnets attached to vlan in specific section
1743
+ operationId: getVlanSubnetsBySection
1744
+ parameters:
1745
+ - name: id
1746
+ in: path
1747
+ description: Vlan identifier, identifies which vlan to work on.
1748
+ required: true
1749
+ style: simple
1750
+ schema:
1751
+ type: string
1752
+ - name: sectionId
1753
+ in: path
1754
+ description: Section identifier
1755
+ required: true
1756
+ style: simple
1757
+ schema:
1758
+ type: string
1759
+ responses:
1760
+ '200':
1761
+ description: successful operation
1762
+ headers: {}
1763
+ content:
1764
+ text/plain:
1765
+ schema:
1766
+ type: string
1767
+ description: successful operation
1768
+ '400':
1769
+ description: failed operation
1770
+ headers: {}
1771
+ content: {}
1772
+ deprecated: false
1773
+ /vlan/{id}/custom_fields:
1774
+ get:
1775
+ tags:
1776
+ - vlans
1777
+ summary: getVlanCustomFields
1778
+ description: Returns custom VLAN fields
1779
+ operationId: getVlanCustomFields
1780
+ parameters:
1781
+ - name: id
1782
+ in: path
1783
+ description: Vlan identifier, identifies which vlan to work on.
1784
+ required: true
1785
+ style: simple
1786
+ schema:
1787
+ type: string
1788
+ responses:
1789
+ '200':
1790
+ description: successful operation
1791
+ headers: {}
1792
+ content:
1793
+ text/plain:
1794
+ schema:
1795
+ type: string
1796
+ description: successful operation
1797
+ '400':
1798
+ description: failed operation
1799
+ headers: {}
1800
+ content: {}
1801
+ deprecated: false
1802
+ /vlan/{id}/search/{number}:
1803
+ get:
1804
+ tags:
1805
+ - vlans
1806
+ summary: getVlanByNumber
1807
+ description: Searches for VLAN
1808
+ operationId: getVlanByNumber
1809
+ parameters:
1810
+ - name: id
1811
+ in: path
1812
+ description: Vlan identifier, identifies which vlan to work on.
1813
+ required: true
1814
+ style: simple
1815
+ schema:
1816
+ type: string
1817
+ - name: number
1818
+ in: path
1819
+ description: Vlan number
1820
+ required: true
1821
+ style: simple
1822
+ schema:
1823
+ type: string
1824
+ responses:
1825
+ '200':
1826
+ description: successful operation
1827
+ headers: {}
1828
+ content:
1829
+ text/plain:
1830
+ schema:
1831
+ type: string
1832
+ description: successful operation
1833
+ '400':
1834
+ description: failed operation
1835
+ headers: {}
1836
+ content: {}
1837
+ deprecated: false
1838
+ /l2domains:
1839
+ get:
1840
+ tags:
1841
+ - l2domains
1842
+ summary: getL2Domains
1843
+ description: Returns all L2 domains
1844
+ operationId: getL2Domains
1845
+ parameters: []
1846
+ responses:
1847
+ '200':
1848
+ description: successful operation
1849
+ headers: {}
1850
+ content:
1851
+ text/plain:
1852
+ schema:
1853
+ type: string
1854
+ description: successful operation
1855
+ '400':
1856
+ description: failed operation
1857
+ headers: {}
1858
+ content: {}
1859
+ deprecated: false
1860
+ post:
1861
+ tags:
1862
+ - l2domains
1863
+ summary: createL2Domain
1864
+ description: Creates new L2 domain
1865
+ operationId: createL2Domain
1866
+ parameters: []
1867
+ requestBody:
1868
+ description: body
1869
+ content:
1870
+ text/plain:
1871
+ schema:
1872
+ type: string
1873
+ description: body
1874
+ required: false
1875
+ responses:
1876
+ '200':
1877
+ description: successful operation
1878
+ headers: {}
1879
+ content:
1880
+ text/plain:
1881
+ schema:
1882
+ type: string
1883
+ description: successful operation
1884
+ '400':
1885
+ description: failed operation
1886
+ headers: {}
1887
+ content: {}
1888
+ deprecated: false
1889
+ patch:
1890
+ tags:
1891
+ - l2domains
1892
+ summary: updateL2Domain
1893
+ description: Updates L2 domain
1894
+ operationId: updateL2Domain
1895
+ parameters: []
1896
+ requestBody:
1897
+ description: body
1898
+ content:
1899
+ text/plain:
1900
+ schema:
1901
+ type: string
1902
+ description: body
1903
+ required: false
1904
+ responses:
1905
+ '200':
1906
+ description: successful operation
1907
+ headers: {}
1908
+ content:
1909
+ text/plain:
1910
+ schema:
1911
+ type: string
1912
+ description: successful operation
1913
+ '400':
1914
+ description: failed operation
1915
+ headers: {}
1916
+ content: {}
1917
+ deprecated: false
1918
+ /l2domains/{id}:
1919
+ get:
1920
+ tags:
1921
+ - l2domains
1922
+ summary: getL2Domain
1923
+ description: Returns specific L2 domain
1924
+ operationId: getL2Domain
1925
+ parameters:
1926
+ - name: id
1927
+ in: path
1928
+ description: L2 domain identifier
1929
+ required: true
1930
+ style: simple
1931
+ schema:
1932
+ type: string
1933
+ responses:
1934
+ '200':
1935
+ description: successful operation
1936
+ headers: {}
1937
+ content:
1938
+ text/plain:
1939
+ schema:
1940
+ type: string
1941
+ description: successful operation
1942
+ '400':
1943
+ description: failed operation
1944
+ headers: {}
1945
+ content: {}
1946
+ deprecated: false
1947
+ /l2domains/{id}/vlans:
1948
+ get:
1949
+ tags:
1950
+ - l2domains
1951
+ summary: getL2DomainVlans
1952
+ description: Returns all VLANs within L2 domain
1953
+ operationId: getL2DomainVlans
1954
+ parameters:
1955
+ - name: id
1956
+ in: path
1957
+ description: L2 domain identifier
1958
+ required: true
1959
+ style: simple
1960
+ schema:
1961
+ type: string
1962
+ responses:
1963
+ '200':
1964
+ description: successful operation
1965
+ headers: {}
1966
+ content:
1967
+ text/plain:
1968
+ schema:
1969
+ type: string
1970
+ description: successful operation
1971
+ '400':
1972
+ description: failed operation
1973
+ headers: {}
1974
+ content: {}
1975
+ deprecated: false
1976
+ /l2domains/custom_fields:
1977
+ get:
1978
+ tags:
1979
+ - l2domains
1980
+ summary: getL2DomainCustomFields
1981
+ description: Returns all custom fields
1982
+ operationId: getL2DomainCustomFields
1983
+ parameters: []
1984
+ responses:
1985
+ '200':
1986
+ description: successful operation
1987
+ headers: {}
1988
+ content:
1989
+ text/plain:
1990
+ schema:
1991
+ type: string
1992
+ description: successful operation
1993
+ '400':
1994
+ description: failed operation
1995
+ headers: {}
1996
+ content: {}
1997
+ deprecated: false
1998
+ /l2domains{id}:
1999
+ delete:
2000
+ tags:
2001
+ - l2domains
2002
+ summary: deleteL2Domain
2003
+ description: Deletes L2 domain
2004
+ operationId: deleteL2Domain
2005
+ parameters:
2006
+ - name: id
2007
+ in: path
2008
+ description: L2 domain identifier
2009
+ required: true
2010
+ style: simple
2011
+ schema:
2012
+ type: string
2013
+ responses:
2014
+ '200':
2015
+ description: successful operation
2016
+ headers: {}
2017
+ content:
2018
+ text/plain:
2019
+ schema:
2020
+ type: string
2021
+ description: successful operation
2022
+ '400':
2023
+ description: failed operation
2024
+ headers: {}
2025
+ content: {}
2026
+ deprecated: false
2027
+ /vrf:
2028
+ get:
2029
+ tags:
2030
+ - vrfs
2031
+ summary: getVRFs
2032
+ description: Returns all VRFs
2033
+ operationId: getVRFs
2034
+ parameters: []
2035
+ responses:
2036
+ '200':
2037
+ description: successful operation
2038
+ headers: {}
2039
+ content:
2040
+ text/plain:
2041
+ schema:
2042
+ type: string
2043
+ description: successful operation
2044
+ '400':
2045
+ description: failed operation
2046
+ headers: {}
2047
+ content: {}
2048
+ deprecated: false
2049
+ post:
2050
+ tags:
2051
+ - vrfs
2052
+ summary: createVRF
2053
+ description: Creates new VRF
2054
+ operationId: createVRF
2055
+ parameters: []
2056
+ requestBody:
2057
+ description: body
2058
+ content:
2059
+ text/plain:
2060
+ schema:
2061
+ type: string
2062
+ description: body
2063
+ required: false
2064
+ responses:
2065
+ '200':
2066
+ description: successful operation
2067
+ headers: {}
2068
+ content:
2069
+ text/plain:
2070
+ schema:
2071
+ type: string
2072
+ description: successful operation
2073
+ '400':
2074
+ description: failed operation
2075
+ headers: {}
2076
+ content: {}
2077
+ deprecated: false
2078
+ patch:
2079
+ tags:
2080
+ - vrfs
2081
+ summary: updateVRF
2082
+ description: Updates VRF
2083
+ operationId: updateVRF
2084
+ parameters: []
2085
+ requestBody:
2086
+ description: body
2087
+ content:
2088
+ text/plain:
2089
+ schema:
2090
+ type: string
2091
+ description: body
2092
+ required: false
2093
+ responses:
2094
+ '200':
2095
+ description: successful operation
2096
+ headers: {}
2097
+ content:
2098
+ text/plain:
2099
+ schema:
2100
+ type: string
2101
+ description: successful operation
2102
+ '400':
2103
+ description: failed operation
2104
+ headers: {}
2105
+ content: {}
2106
+ deprecated: false
2107
+ /vrf/{id}:
2108
+ get:
2109
+ tags:
2110
+ - vrfs
2111
+ summary: getVRF
2112
+ description: Returns specific VRF
2113
+ operationId: getVRF
2114
+ parameters:
2115
+ - name: id
2116
+ in: path
2117
+ description: VRF identifier
2118
+ required: true
2119
+ style: simple
2120
+ schema:
2121
+ type: string
2122
+ responses:
2123
+ '200':
2124
+ description: successful operation
2125
+ headers: {}
2126
+ content:
2127
+ text/plain:
2128
+ schema:
2129
+ type: string
2130
+ description: successful operation
2131
+ '400':
2132
+ description: failed operation
2133
+ headers: {}
2134
+ content: {}
2135
+ deprecated: false
2136
+ delete:
2137
+ tags:
2138
+ - vrfs
2139
+ summary: deleteVRF
2140
+ description: Deletes VRF
2141
+ operationId: deleteVRF
2142
+ parameters:
2143
+ - name: id
2144
+ in: path
2145
+ description: VRF identifier
2146
+ required: true
2147
+ style: simple
2148
+ schema:
2149
+ type: string
2150
+ responses:
2151
+ '200':
2152
+ description: successful operation
2153
+ headers: {}
2154
+ content:
2155
+ text/plain:
2156
+ schema:
2157
+ type: string
2158
+ description: successful operation
2159
+ '400':
2160
+ description: failed operation
2161
+ headers: {}
2162
+ content: {}
2163
+ deprecated: false
2164
+ /vrf/{id}/subnets:
2165
+ get:
2166
+ tags:
2167
+ - vrfs
2168
+ summary: getVRFSubnets
2169
+ description: Returns all subnets within VRF
2170
+ operationId: getVRFSubnets
2171
+ parameters:
2172
+ - name: id
2173
+ in: path
2174
+ description: VRF identifier
2175
+ required: true
2176
+ style: simple
2177
+ schema:
2178
+ type: string
2179
+ responses:
2180
+ '200':
2181
+ description: successful operation
2182
+ headers: {}
2183
+ content:
2184
+ text/plain:
2185
+ schema:
2186
+ type: string
2187
+ description: successful operation
2188
+ '400':
2189
+ description: failed operation
2190
+ headers: {}
2191
+ content: {}
2192
+ deprecated: false
2193
+ /vrf/custom_fields:
2194
+ get:
2195
+ tags:
2196
+ - vrfs
2197
+ summary: getVRFCustomFields
2198
+ description: Returns all custom fields
2199
+ operationId: getVRFCustomFields
2200
+ parameters: []
2201
+ responses:
2202
+ '200':
2203
+ description: successful operation
2204
+ headers: {}
2205
+ content:
2206
+ text/plain:
2207
+ schema:
2208
+ type: string
2209
+ description: successful operation
2210
+ '400':
2211
+ description: failed operation
2212
+ headers: {}
2213
+ content: {}
2214
+ deprecated: false
2215
+ /tools/{subcontroller}:
2216
+ get:
2217
+ tags:
2218
+ - tools
2219
+ summary: toolsGetSubcontrollers
2220
+ description: Returns all subcontroller objects
2221
+ operationId: toolsGetSubcontrollers
2222
+ parameters:
2223
+ - name: subcontroller
2224
+ in: path
2225
+ description: subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)
2226
+ required: true
2227
+ style: simple
2228
+ schema:
2229
+ type: string
2230
+ responses:
2231
+ '200':
2232
+ description: successful operation
2233
+ headers: {}
2234
+ content:
2235
+ text/plain:
2236
+ schema:
2237
+ type: string
2238
+ description: successful operation
2239
+ '400':
2240
+ description: failed operation
2241
+ headers: {}
2242
+ content: {}
2243
+ deprecated: false
2244
+ post:
2245
+ tags:
2246
+ - tools
2247
+ summary: toolsCreateSubcontrollerObject
2248
+ description: Creates new subcontroller object
2249
+ operationId: toolsCreateSubcontrollerObject
2250
+ parameters:
2251
+ - name: subcontroller
2252
+ in: path
2253
+ description: subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)
2254
+ required: true
2255
+ style: simple
2256
+ schema:
2257
+ type: string
2258
+ requestBody:
2259
+ description: body
2260
+ content:
2261
+ text/plain:
2262
+ schema:
2263
+ type: object
2264
+ description: body
2265
+ required: false
2266
+ responses:
2267
+ '200':
2268
+ description: successful operation
2269
+ headers: {}
2270
+ content:
2271
+ text/plain:
2272
+ schema:
2273
+ type: string
2274
+ description: successful operation
2275
+ '400':
2276
+ description: failed operation
2277
+ headers: {}
2278
+ content: {}
2279
+ deprecated: false
2280
+ /tools/{subcontroller}/{identifier}:
2281
+ get:
2282
+ tags:
2283
+ - tools
2284
+ summary: toolsGetSubcontroller
2285
+ description: Returns specific subcontroller object
2286
+ operationId: toolsGetSubcontroller
2287
+ parameters:
2288
+ - name: subcontroller
2289
+ in: path
2290
+ description: subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)
2291
+ required: true
2292
+ style: simple
2293
+ schema:
2294
+ type: string
2295
+ - name: identifier
2296
+ in: path
2297
+ description: id
2298
+ required: true
2299
+ style: simple
2300
+ schema:
2301
+ type: string
2302
+ responses:
2303
+ '200':
2304
+ description: successful operation
2305
+ headers: {}
2306
+ content:
2307
+ text/plain:
2308
+ schema:
2309
+ type: string
2310
+ description: successful operation
2311
+ '400':
2312
+ description: failed operation
2313
+ headers: {}
2314
+ content: {}
2315
+ deprecated: false
2316
+ patch:
2317
+ tags:
2318
+ - tools
2319
+ summary: toolsUpdateSubcontrollerObject
2320
+ description: Updates subcontroller object
2321
+ operationId: toolsUpdateSubcontrollerObject
2322
+ parameters:
2323
+ - name: subcontroller
2324
+ in: path
2325
+ description: subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)
2326
+ required: true
2327
+ style: simple
2328
+ schema:
2329
+ type: string
2330
+ - name: identifier
2331
+ in: path
2332
+ description: id
2333
+ required: true
2334
+ style: simple
2335
+ schema:
2336
+ type: string
2337
+ requestBody:
2338
+ description: body
2339
+ content:
2340
+ text/plain:
2341
+ schema:
2342
+ type: string
2343
+ description: body
2344
+ required: false
2345
+ responses:
2346
+ '200':
2347
+ description: successful operation
2348
+ headers: {}
2349
+ content:
2350
+ text/plain:
2351
+ schema:
2352
+ type: string
2353
+ description: successful operation
2354
+ '400':
2355
+ description: failed operation
2356
+ headers: {}
2357
+ content: {}
2358
+ deprecated: false
2359
+ delete:
2360
+ tags:
2361
+ - tools
2362
+ summary: toolsDeleteSubcontrollerObject
2363
+ description: Deletes subcontroller object
2364
+ operationId: toolsDeleteSubcontrollerObject
2365
+ parameters:
2366
+ - name: subcontroller
2367
+ in: path
2368
+ description: subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)
2369
+ required: true
2370
+ style: simple
2371
+ schema:
2372
+ type: string
2373
+ - name: identifier
2374
+ in: path
2375
+ description: id
2376
+ required: true
2377
+ style: simple
2378
+ schema:
2379
+ type: string
2380
+ responses:
2381
+ '200':
2382
+ description: successful operation
2383
+ headers: {}
2384
+ content:
2385
+ text/plain:
2386
+ schema:
2387
+ type: string
2388
+ description: successful operation
2389
+ '400':
2390
+ description: failed operation
2391
+ headers: {}
2392
+ content: {}
2393
+ deprecated: false
2394
+ /tools/device_types/{id}:
2395
+ get:
2396
+ tags:
2397
+ - tools
2398
+ summary: toolsGetDeviceTypeDetails
2399
+ description: Returns device type details
2400
+ operationId: toolsGetDeviceTypeDetails
2401
+ parameters:
2402
+ - name: id
2403
+ in: path
2404
+ description: id
2405
+ required: true
2406
+ style: simple
2407
+ schema:
2408
+ type: string
2409
+ responses:
2410
+ '200':
2411
+ description: successful operation
2412
+ headers: {}
2413
+ content:
2414
+ text/plain:
2415
+ schema:
2416
+ type: string
2417
+ description: successful operation
2418
+ '400':
2419
+ description: failed operation
2420
+ headers: {}
2421
+ content: {}
2422
+ deprecated: false
2423
+ /tools/device_types/{id}/devices:
2424
+ get:
2425
+ tags:
2426
+ - tools
2427
+ summary: toolsGetDevicesByDeviceType
2428
+ description: Returns all devices with devicetype
2429
+ operationId: toolsGetDevicesByDeviceType
2430
+ parameters:
2431
+ - name: id
2432
+ in: path
2433
+ description: id
2434
+ required: true
2435
+ style: simple
2436
+ schema:
2437
+ type: string
2438
+ responses:
2439
+ '200':
2440
+ description: successful operation
2441
+ headers: {}
2442
+ content:
2443
+ text/plain:
2444
+ schema:
2445
+ type: string
2446
+ description: successful operation
2447
+ '400':
2448
+ description: failed operation
2449
+ headers: {}
2450
+ content: {}
2451
+ deprecated: false
2452
+ /tools/vlans/{id}/subnets:
2453
+ get:
2454
+ tags:
2455
+ - tools
2456
+ summary: toolsGetSubnetsByVLAN
2457
+ description: Returns all subnets that belong to VLAN
2458
+ operationId: toolsGetSubnetsByVLAN
2459
+ parameters:
2460
+ - name: id
2461
+ in: path
2462
+ description: id
2463
+ required: true
2464
+ style: simple
2465
+ schema:
2466
+ type: string
2467
+ responses:
2468
+ '200':
2469
+ description: successful operation
2470
+ headers: {}
2471
+ content:
2472
+ text/plain:
2473
+ schema:
2474
+ type: string
2475
+ description: successful operation
2476
+ '400':
2477
+ description: failed operation
2478
+ headers: {}
2479
+ content: {}
2480
+ deprecated: false
2481
+ /tools/vrfs/{id}/subnets:
2482
+ get:
2483
+ tags:
2484
+ - tools
2485
+ summary: toolsGetSubnetsByVRF
2486
+ description: Returns all subnets that belong to VRF
2487
+ operationId: toolsGetSubnetsByVRF
2488
+ parameters:
2489
+ - name: id
2490
+ in: path
2491
+ description: id
2492
+ required: true
2493
+ style: simple
2494
+ schema:
2495
+ type: string
2496
+ responses:
2497
+ '200':
2498
+ description: successful operation
2499
+ headers: {}
2500
+ content:
2501
+ text/plain:
2502
+ schema:
2503
+ type: string
2504
+ description: successful operation
2505
+ '400':
2506
+ description: failed operation
2507
+ headers: {}
2508
+ content: {}
2509
+ deprecated: false
2510
+ /tools/locations/{id}/subnets:
2511
+ get:
2512
+ tags:
2513
+ - tools
2514
+ summary: toolsGetSubnetsByLocation
2515
+ description: Returns all subnets that belong to Location
2516
+ operationId: toolsGetSubnetsByLocation
2517
+ parameters:
2518
+ - name: id
2519
+ in: path
2520
+ description: id
2521
+ required: true
2522
+ style: simple
2523
+ schema:
2524
+ type: string
2525
+ responses:
2526
+ '200':
2527
+ description: successful operation
2528
+ headers: {}
2529
+ content:
2530
+ text/plain:
2531
+ schema:
2532
+ type: string
2533
+ description: successful operation
2534
+ '400':
2535
+ description: failed operation
2536
+ headers: {}
2537
+ content: {}
2538
+ deprecated: false
2539
+ /tools/locations/{id}/devices:
2540
+ get:
2541
+ tags:
2542
+ - tools
2543
+ summary: toolsGetDevicesByLocation
2544
+ description: Returns all devices that belong to Location
2545
+ operationId: toolsGetDevicesByLocation
2546
+ parameters:
2547
+ - name: id
2548
+ in: path
2549
+ description: id
2550
+ required: true
2551
+ style: simple
2552
+ schema:
2553
+ type: string
2554
+ responses:
2555
+ '200':
2556
+ description: successful operation
2557
+ headers: {}
2558
+ content:
2559
+ text/plain:
2560
+ schema:
2561
+ type: string
2562
+ description: successful operation
2563
+ '400':
2564
+ description: failed operation
2565
+ headers: {}
2566
+ content: {}
2567
+ deprecated: false
2568
+ /tools/locations/{id}/racks:
2569
+ get:
2570
+ tags:
2571
+ - tools
2572
+ summary: toolsGetRacksByLocation
2573
+ description: Returns all racks that belong to Location
2574
+ operationId: toolsGetRacksByLocation
2575
+ parameters:
2576
+ - name: id
2577
+ in: path
2578
+ description: id
2579
+ required: true
2580
+ style: simple
2581
+ schema:
2582
+ type: string
2583
+ responses:
2584
+ '200':
2585
+ description: successful operation
2586
+ headers: {}
2587
+ content:
2588
+ text/plain:
2589
+ schema:
2590
+ type: string
2591
+ description: successful operation
2592
+ '400':
2593
+ description: failed operation
2594
+ headers: {}
2595
+ content: {}
2596
+ deprecated: false
2597
+ /tools/racks/{id}/devices:
2598
+ get:
2599
+ tags:
2600
+ - tools
2601
+ summary: toolsGetDevicesByRack
2602
+ description: Returns all devices that belong to rack
2603
+ operationId: toolsGetDevicesByRack
2604
+ parameters:
2605
+ - name: id
2606
+ in: path
2607
+ description: id
2608
+ required: true
2609
+ style: simple
2610
+ schema:
2611
+ type: string
2612
+ responses:
2613
+ '200':
2614
+ description: successful operation
2615
+ headers: {}
2616
+ content:
2617
+ text/plain:
2618
+ schema:
2619
+ type: string
2620
+ description: successful operation
2621
+ '400':
2622
+ description: failed operation
2623
+ headers: {}
2624
+ content: {}
2625
+ deprecated: false
2626
+ /tools/nat/{id}/objects:
2627
+ get:
2628
+ tags:
2629
+ - tools
2630
+ summary: getNATDetailsAttachedObjects
2631
+ description: Returns nat details and array of all attached objects
2632
+ operationId: getNATDetailsAttachedObjects
2633
+ parameters:
2634
+ - name: id
2635
+ in: path
2636
+ description: id
2637
+ required: true
2638
+ style: simple
2639
+ schema:
2640
+ type: string
2641
+ responses:
2642
+ '200':
2643
+ description: successful operation
2644
+ headers: {}
2645
+ content:
2646
+ text/plain:
2647
+ schema:
2648
+ type: string
2649
+ description: successful operation
2650
+ '400':
2651
+ description: failed operation
2652
+ headers: {}
2653
+ content: {}
2654
+ deprecated: false
2655
+ /tools/nat/{id}/objects_full:
2656
+ get:
2657
+ tags:
2658
+ - tools
2659
+ summary: getNATDetailsAllObjects
2660
+ description: Returns nat details and full array of all attached objects
2661
+ operationId: getNATDetailsAllObjects
2662
+ parameters:
2663
+ - name: id
2664
+ in: path
2665
+ description: id
2666
+ required: true
2667
+ style: simple
2668
+ schema:
2669
+ type: string
2670
+ responses:
2671
+ '200':
2672
+ description: successful operation
2673
+ headers: {}
2674
+ content:
2675
+ text/plain:
2676
+ schema:
2677
+ type: string
2678
+ description: successful operation
2679
+ '400':
2680
+ description: failed operation
2681
+ headers: {}
2682
+ content: {}
2683
+ deprecated: false
2684
+ /prefix/{customer_type}:
2685
+ get:
2686
+ tags:
2687
+ - prefix
2688
+ summary: prefixGetSubnetsUsedToDeliverSubnets
2689
+ description: Returns all subnets used to deliver new subnets
2690
+ operationId: prefixGetSubnetsUsedToDeliverSubnets
2691
+ parameters:
2692
+ - name: customer_type
2693
+ in: path
2694
+ description: customer_type
2695
+ required: true
2696
+ style: simple
2697
+ schema:
2698
+ type: string
2699
+ responses:
2700
+ '200':
2701
+ description: successful operation
2702
+ headers: {}
2703
+ content:
2704
+ text/plain:
2705
+ schema:
2706
+ type: string
2707
+ description: successful operation
2708
+ '400':
2709
+ description: failed operation
2710
+ headers: {}
2711
+ content: {}
2712
+ deprecated: false
2713
+ /prefix/{customer_type}/{ip_version}:
2714
+ get:
2715
+ tags:
2716
+ - prefix
2717
+ summary: prefixGetSubnetsUsedToDeliverSubnetsVersion
2718
+ description: Returns all subnets used to deliver new subnets for specific IP version * ip_version can be IPv4, IPv6, v4, v6
2719
+ operationId: prefixGetSubnetsUsedToDeliverSubnetsVersion
2720
+ parameters:
2721
+ - name: customer_type
2722
+ in: path
2723
+ description: customer_type
2724
+ required: true
2725
+ style: simple
2726
+ schema:
2727
+ type: string
2728
+ - name: ip_version
2729
+ in: path
2730
+ description: ip_version
2731
+ required: true
2732
+ style: simple
2733
+ schema:
2734
+ type: string
2735
+ responses:
2736
+ '200':
2737
+ description: successful operation
2738
+ headers: {}
2739
+ content:
2740
+ text/plain:
2741
+ schema:
2742
+ type: string
2743
+ description: successful operation
2744
+ '400':
2745
+ description: failed operation
2746
+ headers: {}
2747
+ content: {}
2748
+ deprecated: false
2749
+ /prefix/{customer_type}/address:
2750
+ get:
2751
+ tags:
2752
+ - prefix
2753
+ summary: prefixGetSubnetsUsedToDeliverNewAddresses
2754
+ description: Returns all subnets used to deliver new addresses
2755
+ operationId: prefixGetSubnetsUsedToDeliverNewAddresses
2756
+ parameters:
2757
+ - name: customer_type
2758
+ in: path
2759
+ description: customer_type
2760
+ required: true
2761
+ style: simple
2762
+ schema:
2763
+ type: string
2764
+ responses:
2765
+ '200':
2766
+ description: successful operation
2767
+ headers: {}
2768
+ content:
2769
+ text/plain:
2770
+ schema:
2771
+ type: string
2772
+ description: successful operation
2773
+ '400':
2774
+ description: failed operation
2775
+ headers: {}
2776
+ content: {}
2777
+ deprecated: false
2778
+ /prefix/{customer_type}/address/{ip_version}:
2779
+ get:
2780
+ tags:
2781
+ - prefix
2782
+ summary: prefixGetSubnetsUsedToDeliverNewAddressesVersion
2783
+ description: Returns all subnets used to deliver new addresses for specific IP version
2784
+ operationId: prefixGetSubnetsUsedToDeliverNewAddressesVersion
2785
+ parameters:
2786
+ - name: customer_type
2787
+ in: path
2788
+ description: customer_type
2789
+ required: true
2790
+ style: simple
2791
+ schema:
2792
+ type: string
2793
+ - name: ip_version
2794
+ in: path
2795
+ description: ip_version
2796
+ required: true
2797
+ style: simple
2798
+ schema:
2799
+ type: string
2800
+ responses:
2801
+ '200':
2802
+ description: successful operation
2803
+ headers: {}
2804
+ content:
2805
+ text/plain:
2806
+ schema:
2807
+ type: string
2808
+ description: successful operation
2809
+ '400':
2810
+ description: failed operation
2811
+ headers: {}
2812
+ content: {}
2813
+ deprecated: false
2814
+ /prefix/{customer_type}/{ip_version}/{mask}:
2815
+ get:
2816
+ tags:
2817
+ - prefix
2818
+ summary: prefixGetFirstAvailableSubnet
2819
+ description: Returns first available subnet for ip version and requested mask
2820
+ operationId: prefixGetFirstAvailableSubnet
2821
+ parameters:
2822
+ - name: customer_type
2823
+ in: path
2824
+ description: customer_type
2825
+ required: true
2826
+ style: simple
2827
+ schema:
2828
+ type: string
2829
+ - name: ip_version
2830
+ in: path
2831
+ description: ip_version
2832
+ required: true
2833
+ style: simple
2834
+ schema:
2835
+ type: string
2836
+ - name: mask
2837
+ in: path
2838
+ description: mask
2839
+ required: true
2840
+ style: simple
2841
+ schema:
2842
+ type: string
2843
+ responses:
2844
+ '200':
2845
+ description: successful operation
2846
+ headers: {}
2847
+ content:
2848
+ text/plain:
2849
+ schema:
2850
+ type: string
2851
+ description: successful operation
2852
+ '400':
2853
+ description: failed operation
2854
+ headers: {}
2855
+ content: {}
2856
+ deprecated: false
2857
+ post:
2858
+ tags:
2859
+ - prefix
2860
+ summary: prefixPostFirstAvailableSubnet
2861
+ description: Creates first available subnet for ip version and requested mask
2862
+ operationId: prefixPostFirstAvailableSubnet
2863
+ parameters:
2864
+ - name: customer_type
2865
+ in: path
2866
+ description: customer_type
2867
+ required: true
2868
+ style: simple
2869
+ schema:
2870
+ type: string
2871
+ - name: ip_version
2872
+ in: path
2873
+ description: ip_version
2874
+ required: true
2875
+ style: simple
2876
+ schema:
2877
+ type: string
2878
+ - name: mask
2879
+ in: path
2880
+ description: mask
2881
+ required: true
2882
+ style: simple
2883
+ schema:
2884
+ type: string
2885
+ requestBody:
2886
+ description: body
2887
+ content:
2888
+ text/plain:
2889
+ schema:
2890
+ type: object
2891
+ description: body
2892
+ required: false
2893
+ responses:
2894
+ '200':
2895
+ description: successful operation
2896
+ headers: {}
2897
+ content:
2898
+ text/plain:
2899
+ schema:
2900
+ type: string
2901
+ description: successful operation
2902
+ '400':
2903
+ description: failed operation
2904
+ headers: {}
2905
+ content: {}
2906
+ deprecated: false
2907
+ /prefix/{customer_type}/{ip_version}/address:
2908
+ get:
2909
+ tags:
2910
+ - prefix
2911
+ summary: prefixGetFirstAvailableAddress
2912
+ description: Returns first available address for ip version
2913
+ operationId: prefixGetFirstAvailableAddress
2914
+ parameters:
2915
+ - name: customer_type
2916
+ in: path
2917
+ description: customer_type
2918
+ required: true
2919
+ style: simple
2920
+ schema:
2921
+ type: string
2922
+ - name: ip_version
2923
+ in: path
2924
+ description: ip_version
2925
+ required: true
2926
+ style: simple
2927
+ schema:
2928
+ type: string
2929
+ responses:
2930
+ '200':
2931
+ description: successful operation
2932
+ headers: {}
2933
+ content:
2934
+ text/plain:
2935
+ schema:
2936
+ type: string
2937
+ description: successful operation
2938
+ '400':
2939
+ description: failed operation
2940
+ headers: {}
2941
+ content: {}
2942
+ deprecated: false
2943
+ post:
2944
+ tags:
2945
+ - prefix
2946
+ summary: prefixPostFirstAvailableAddress
2947
+ description: Creates first available address for ip version
2948
+ operationId: prefixPostFirstAvailableAddress
2949
+ parameters:
2950
+ - name: customer_type
2951
+ in: path
2952
+ description: customer_type
2953
+ required: true
2954
+ style: simple
2955
+ schema:
2956
+ type: string
2957
+ - name: ip_version
2958
+ in: path
2959
+ description: ip_version
2960
+ required: true
2961
+ style: simple
2962
+ schema:
2963
+ type: string
2964
+ requestBody:
2965
+ description: body
2966
+ content:
2967
+ text/plain:
2968
+ schema:
2969
+ type: string
2970
+ description: body
2971
+ required: false
2972
+ responses:
2973
+ '200':
2974
+ description: successful operation
2975
+ headers: {}
2976
+ content:
2977
+ text/plain:
2978
+ schema:
2979
+ type: string
2980
+ description: successful operation
2981
+ '400':
2982
+ description: failed operation
2983
+ headers: {}
2984
+ content: {}
2985
+ deprecated: false
2986
+ tags:
2987
+ - name: sections
2988
+ description: sections controller
2989
+ - name: subnets
2990
+ description: subnets controller
2991
+ - name: devices
2992
+ description: devices controller
2993
+ - name: addresses
2994
+ description: addresses controller
2995
+ - name: vlans
2996
+ description: vlans controller
2997
+ - name: l2domains
2998
+ description: l2domains controller
2999
+ - name: vrfs
3000
+ description: vrfs controller
3001
+ - name: tools
3002
+ description: tools controller
3003
+ - name: prefix
3004
+ description: prefix controller
3005
+ - name: default
3006
+ description: ''
3007
+ externalDocs:
3008
+ url: http://swagger.io
3009
+ externalDocs:
3010
+ description: Find out more about Swagger
3011
+ url: http://swagger.io