@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,4152 @@
1
+ {
2
+ "openapi": "3.0.0",
3
+ "info": {
4
+ "title": "phpipam",
5
+ "description": "Open-source IP address management",
6
+ "contact": {
7
+ "email": "apiteam@swagger.io"
8
+ },
9
+ "version": "1.0.0"
10
+ },
11
+ "servers": [
12
+ {
13
+ "url": "https://your.host.name.io/api",
14
+ "variables": {}
15
+ },
16
+ {
17
+ "url": "http://your.host.name.io/api",
18
+ "variables": {}
19
+ }
20
+ ],
21
+ "paths": {
22
+ "/sections": {
23
+ "get": {
24
+ "tags": [
25
+ "sections"
26
+ ],
27
+ "summary": "getSections",
28
+ "description": "Returns all sections",
29
+ "operationId": "getSections",
30
+ "parameters": [],
31
+ "responses": {
32
+ "200": {
33
+ "description": "successful operation",
34
+ "headers": {},
35
+ "content": {
36
+ "text/plain": {
37
+ "schema": {
38
+ "type": "string",
39
+ "description": "successful operation"
40
+ }
41
+ }
42
+ }
43
+ },
44
+ "400": {
45
+ "description": "failed operation"
46
+ }
47
+ },
48
+ "deprecated": false
49
+ },
50
+ "post": {
51
+ "tags": [
52
+ "sections"
53
+ ],
54
+ "summary": "createSection",
55
+ "description": "Creates new section",
56
+ "operationId": "createSection",
57
+ "parameters": [],
58
+ "requestBody": {
59
+ "description": "body",
60
+ "content": {
61
+ "text/plain": {
62
+ "schema": {
63
+ "type": "string",
64
+ "description": "body"
65
+ }
66
+ }
67
+ },
68
+ "required": false
69
+ },
70
+ "responses": {
71
+ "200": {
72
+ "description": "successful operation",
73
+ "headers": {},
74
+ "content": {
75
+ "text/plain": {
76
+ "schema": {
77
+ "type": "string",
78
+ "description": "successful operation"
79
+ }
80
+ }
81
+ }
82
+ },
83
+ "400": {
84
+ "description": "failed operation"
85
+ }
86
+ },
87
+ "deprecated": false
88
+ },
89
+ "patch": {
90
+ "tags": [
91
+ "sections"
92
+ ],
93
+ "summary": "updateSection",
94
+ "description": "Updates section",
95
+ "operationId": "updateSection",
96
+ "parameters": [],
97
+ "requestBody": {
98
+ "description": "body",
99
+ "content": {
100
+ "text/plain": {
101
+ "schema": {
102
+ "type": "string",
103
+ "description": "body"
104
+ }
105
+ }
106
+ },
107
+ "required": false
108
+ },
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
+ }
119
+ }
120
+ }
121
+ },
122
+ "400": {
123
+ "description": "failed operation"
124
+ }
125
+ },
126
+ "deprecated": false
127
+ }
128
+ },
129
+ "/sections/{id}": {
130
+ "get": {
131
+ "tags": [
132
+ "sections"
133
+ ],
134
+ "summary": "getSection",
135
+ "description": "Returns specific section",
136
+ "operationId": "getSection",
137
+ "parameters": [
138
+ {
139
+ "name": "id",
140
+ "in": "path",
141
+ "description": "Section identifier, identifies which section to work on.",
142
+ "required": true,
143
+ "style": "simple",
144
+ "schema": {
145
+ "type": "string"
146
+ }
147
+ }
148
+ ],
149
+ "responses": {
150
+ "200": {
151
+ "description": "successful operation",
152
+ "headers": {},
153
+ "content": {
154
+ "text/plain": {
155
+ "schema": {
156
+ "type": "string",
157
+ "description": "successful operation"
158
+ }
159
+ }
160
+ }
161
+ },
162
+ "400": {
163
+ "description": "failed operation"
164
+ }
165
+ },
166
+ "deprecated": false
167
+ },
168
+ "delete": {
169
+ "tags": [
170
+ "sections"
171
+ ],
172
+ "summary": "deleteSection",
173
+ "description": "Deletes section with all belonging subnets and addresses",
174
+ "operationId": "deleteSection",
175
+ "parameters": [
176
+ {
177
+ "name": "id",
178
+ "in": "path",
179
+ "description": "Section identifier, identifies which section to work on.",
180
+ "required": true,
181
+ "style": "simple",
182
+ "schema": {
183
+ "type": "string"
184
+ }
185
+ }
186
+ ],
187
+ "responses": {
188
+ "200": {
189
+ "description": "successful operation",
190
+ "headers": {},
191
+ "content": {
192
+ "text/plain": {
193
+ "schema": {
194
+ "type": "string",
195
+ "description": "successful operation"
196
+ }
197
+ }
198
+ }
199
+ },
200
+ "400": {
201
+ "description": "failed operation"
202
+ }
203
+ },
204
+ "deprecated": false
205
+ }
206
+ },
207
+ "/sections/{id}/subnets": {
208
+ "get": {
209
+ "tags": [
210
+ "sections"
211
+ ],
212
+ "summary": "getSectionSubnets",
213
+ "description": "Returns all subnets in section",
214
+ "operationId": "getSectionSubnets",
215
+ "parameters": [
216
+ {
217
+ "name": "id",
218
+ "in": "path",
219
+ "description": "Section identifier, identifies which section to work on.",
220
+ "required": true,
221
+ "style": "simple",
222
+ "schema": {
223
+ "type": "string"
224
+ }
225
+ }
226
+ ],
227
+ "responses": {
228
+ "200": {
229
+ "description": "successful operation",
230
+ "headers": {},
231
+ "content": {
232
+ "text/plain": {
233
+ "schema": {
234
+ "type": "string",
235
+ "description": "successful operation"
236
+ }
237
+ }
238
+ }
239
+ },
240
+ "400": {
241
+ "description": "failed operation"
242
+ }
243
+ },
244
+ "deprecated": false
245
+ }
246
+ },
247
+ "/sections/{name}": {
248
+ "get": {
249
+ "tags": [
250
+ "sections"
251
+ ],
252
+ "summary": "getSectionByName",
253
+ "description": "Returns specific section by name",
254
+ "operationId": "getSectionByName",
255
+ "parameters": [
256
+ {
257
+ "name": "name",
258
+ "in": "path",
259
+ "description": "Section name, unique value",
260
+ "required": true,
261
+ "style": "simple",
262
+ "schema": {
263
+ "type": "string"
264
+ }
265
+ }
266
+ ],
267
+ "responses": {
268
+ "200": {
269
+ "description": "successful operation",
270
+ "headers": {},
271
+ "content": {
272
+ "text/plain": {
273
+ "schema": {
274
+ "type": "string",
275
+ "description": "successful operation"
276
+ }
277
+ }
278
+ }
279
+ },
280
+ "400": {
281
+ "description": "failed operation"
282
+ }
283
+ },
284
+ "deprecated": false
285
+ }
286
+ },
287
+ "/sections/custom_fields": {
288
+ "get": {
289
+ "tags": [
290
+ "sections"
291
+ ],
292
+ "summary": "getSectionsCustomFields",
293
+ "description": "Returns custom section fields",
294
+ "operationId": "getSectionsCustomFields",
295
+ "parameters": [],
296
+ "responses": {
297
+ "200": {
298
+ "description": "successful operation",
299
+ "headers": {},
300
+ "content": {
301
+ "text/plain": {
302
+ "schema": {
303
+ "type": "string",
304
+ "description": "successful operation"
305
+ }
306
+ }
307
+ }
308
+ },
309
+ "400": {
310
+ "description": "failed operation"
311
+ }
312
+ },
313
+ "deprecated": false
314
+ }
315
+ },
316
+ "/subnets/{id}": {
317
+ "get": {
318
+ "tags": [
319
+ "subnets"
320
+ ],
321
+ "summary": "getSubnet",
322
+ "description": "Returns specific subnet by id",
323
+ "operationId": "getSubnet",
324
+ "parameters": [
325
+ {
326
+ "name": "id",
327
+ "in": "path",
328
+ "description": "Subnet identifier, identifies which subnetto work on.",
329
+ "required": true,
330
+ "style": "simple",
331
+ "schema": {
332
+ "type": "string"
333
+ }
334
+ }
335
+ ],
336
+ "responses": {
337
+ "200": {
338
+ "description": "successful operation",
339
+ "headers": {},
340
+ "content": {
341
+ "text/plain": {
342
+ "schema": {
343
+ "type": "string",
344
+ "description": "successful operation"
345
+ }
346
+ }
347
+ }
348
+ },
349
+ "400": {
350
+ "description": "failed operation"
351
+ }
352
+ },
353
+ "deprecated": false
354
+ },
355
+ "delete": {
356
+ "tags": [
357
+ "subnets"
358
+ ],
359
+ "summary": "deleteSubnet",
360
+ "description": "Deletes Subnet",
361
+ "operationId": "deleteSubnet",
362
+ "parameters": [
363
+ {
364
+ "name": "id",
365
+ "in": "path",
366
+ "description": "Subnet identifier, identifies which subnetto work on.",
367
+ "required": true,
368
+ "style": "simple",
369
+ "schema": {
370
+ "type": "string"
371
+ }
372
+ }
373
+ ],
374
+ "responses": {
375
+ "200": {
376
+ "description": "successful operation",
377
+ "headers": {},
378
+ "content": {
379
+ "text/plain": {
380
+ "schema": {
381
+ "type": "string",
382
+ "description": "successful operation"
383
+ }
384
+ }
385
+ }
386
+ },
387
+ "400": {
388
+ "description": "failed operation"
389
+ }
390
+ },
391
+ "deprecated": false
392
+ }
393
+ },
394
+ "/subnets/{id}/usage": {
395
+ "get": {
396
+ "tags": [
397
+ "subnets"
398
+ ],
399
+ "summary": "getSubnetUsage",
400
+ "description": "Returns subnet usage",
401
+ "operationId": "getSubnetUsage",
402
+ "parameters": [
403
+ {
404
+ "name": "id",
405
+ "in": "path",
406
+ "description": "Subnet identifier, identifies which subnetto work on.",
407
+ "required": true,
408
+ "style": "simple",
409
+ "schema": {
410
+ "type": "string"
411
+ }
412
+ }
413
+ ],
414
+ "responses": {
415
+ "200": {
416
+ "description": "successful operation",
417
+ "headers": {},
418
+ "content": {
419
+ "text/plain": {
420
+ "schema": {
421
+ "type": "string",
422
+ "description": "successful operation"
423
+ }
424
+ }
425
+ }
426
+ },
427
+ "400": {
428
+ "description": "failed operation"
429
+ }
430
+ },
431
+ "deprecated": false
432
+ }
433
+ },
434
+ "/subnets/{id}/first_free": {
435
+ "get": {
436
+ "tags": [
437
+ "subnets"
438
+ ],
439
+ "summary": "getSubnetFirstFree",
440
+ "description": "Returns first available IP address in subnet",
441
+ "operationId": "getSubnetFirstFree",
442
+ "parameters": [
443
+ {
444
+ "name": "id",
445
+ "in": "path",
446
+ "description": "Subnet identifier, identifies which subnetto work on.",
447
+ "required": true,
448
+ "style": "simple",
449
+ "schema": {
450
+ "type": "string"
451
+ }
452
+ }
453
+ ],
454
+ "responses": {
455
+ "200": {
456
+ "description": "successful operation",
457
+ "headers": {},
458
+ "content": {
459
+ "text/plain": {
460
+ "schema": {
461
+ "type": "string",
462
+ "description": "successful operation"
463
+ }
464
+ }
465
+ }
466
+ },
467
+ "400": {
468
+ "description": "failed operation"
469
+ }
470
+ },
471
+ "deprecated": false
472
+ }
473
+ },
474
+ "/subnets/{id}/slaves": {
475
+ "get": {
476
+ "tags": [
477
+ "subnets"
478
+ ],
479
+ "summary": "getSubnetSlaves",
480
+ "description": "Returns all immediate slave subnets",
481
+ "operationId": "getSubnetSlaves",
482
+ "parameters": [
483
+ {
484
+ "name": "id",
485
+ "in": "path",
486
+ "description": "Subnet identifier, identifies which subnetto work on.",
487
+ "required": true,
488
+ "style": "simple",
489
+ "schema": {
490
+ "type": "string"
491
+ }
492
+ }
493
+ ],
494
+ "responses": {
495
+ "200": {
496
+ "description": "successful operation",
497
+ "headers": {},
498
+ "content": {
499
+ "text/plain": {
500
+ "schema": {
501
+ "type": "string",
502
+ "description": "successful operation"
503
+ }
504
+ }
505
+ }
506
+ },
507
+ "400": {
508
+ "description": "failed operation"
509
+ }
510
+ },
511
+ "deprecated": false
512
+ }
513
+ },
514
+ "/subnets/{id}/slaves_recursive": {
515
+ "get": {
516
+ "tags": [
517
+ "subnets"
518
+ ],
519
+ "summary": "getSubnetSlavesRecursive",
520
+ "description": "Returns all slave subnets recursive",
521
+ "operationId": "getSubnetSlavesRecursive",
522
+ "parameters": [
523
+ {
524
+ "name": "id",
525
+ "in": "path",
526
+ "description": "Subnet identifier, identifies which subnetto work on.",
527
+ "required": true,
528
+ "style": "simple",
529
+ "schema": {
530
+ "type": "string"
531
+ }
532
+ }
533
+ ],
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
+ }
544
+ }
545
+ }
546
+ },
547
+ "400": {
548
+ "description": "failed operation"
549
+ }
550
+ },
551
+ "deprecated": false
552
+ }
553
+ },
554
+ "/subnets/{id}/addresses": {
555
+ "get": {
556
+ "tags": [
557
+ "subnets"
558
+ ],
559
+ "summary": "getSubnetAddresses",
560
+ "description": "Returns all addresses in subnet",
561
+ "operationId": "getSubnetAddresses",
562
+ "parameters": [
563
+ {
564
+ "name": "id",
565
+ "in": "path",
566
+ "description": "Subnet identifier, identifies which subnetto work on.",
567
+ "required": true,
568
+ "style": "simple",
569
+ "schema": {
570
+ "type": "string"
571
+ }
572
+ }
573
+ ],
574
+ "responses": {
575
+ "200": {
576
+ "description": "successful operation",
577
+ "headers": {},
578
+ "content": {
579
+ "text/plain": {
580
+ "schema": {
581
+ "type": "string",
582
+ "description": "successful operation"
583
+ }
584
+ }
585
+ }
586
+ },
587
+ "400": {
588
+ "description": "failed operation"
589
+ }
590
+ },
591
+ "deprecated": false
592
+ }
593
+ },
594
+ "/subnets/{id}/addresses/{ip}": {
595
+ "get": {
596
+ "tags": [
597
+ "subnets"
598
+ ],
599
+ "summary": "getSubnetIPAddress",
600
+ "description": "Returns IP address from subnet",
601
+ "operationId": "getSubnetIPAddress",
602
+ "parameters": [
603
+ {
604
+ "name": "id",
605
+ "in": "path",
606
+ "description": "Subnet identifier, identifies which subnetto work on.",
607
+ "required": true,
608
+ "style": "simple",
609
+ "schema": {
610
+ "type": "string"
611
+ }
612
+ },
613
+ {
614
+ "name": "ip",
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
+ }
622
+ }
623
+ ],
624
+ "responses": {
625
+ "200": {
626
+ "description": "successful operation",
627
+ "headers": {},
628
+ "content": {
629
+ "text/plain": {
630
+ "schema": {
631
+ "type": "string",
632
+ "description": "successful operation"
633
+ }
634
+ }
635
+ }
636
+ },
637
+ "400": {
638
+ "description": "failed operation"
639
+ }
640
+ },
641
+ "deprecated": false
642
+ }
643
+ },
644
+ "/subnets/{id}/first_subnet/{mask}": {
645
+ "get": {
646
+ "tags": [
647
+ "subnets"
648
+ ],
649
+ "summary": "getSubnetFirstAvailable",
650
+ "description": "Returns first available subnet within selected for mask",
651
+ "operationId": "getSubnetFirstAvailable",
652
+ "parameters": [
653
+ {
654
+ "name": "id",
655
+ "in": "path",
656
+ "description": "Subnet identifier, identifies which subnetto work on.",
657
+ "required": true,
658
+ "style": "simple",
659
+ "schema": {
660
+ "type": "string"
661
+ }
662
+ },
663
+ {
664
+ "name": "mask",
665
+ "in": "path",
666
+ "description": "Subnet bitmask",
667
+ "required": true,
668
+ "style": "simple",
669
+ "schema": {
670
+ "type": "string"
671
+ }
672
+ }
673
+ ],
674
+ "responses": {
675
+ "200": {
676
+ "description": "successful operation",
677
+ "headers": {},
678
+ "content": {
679
+ "text/plain": {
680
+ "schema": {
681
+ "type": "string",
682
+ "description": "successful operation"
683
+ }
684
+ }
685
+ }
686
+ },
687
+ "400": {
688
+ "description": "failed operation"
689
+ }
690
+ },
691
+ "deprecated": false
692
+ },
693
+ "post": {
694
+ "tags": [
695
+ "subnets"
696
+ ],
697
+ "summary": "createSubnetInsideSubnet",
698
+ "description": "Creates new child subnet inside subnet with specified mask",
699
+ "operationId": "createSubnetInsideSubnet",
700
+ "parameters": [
701
+ {
702
+ "name": "id",
703
+ "in": "path",
704
+ "description": "",
705
+ "required": true,
706
+ "style": "simple",
707
+ "schema": {
708
+ "type": "string"
709
+ }
710
+ },
711
+ {
712
+ "name": "mask",
713
+ "in": "path",
714
+ "description": "",
715
+ "required": true,
716
+ "style": "simple",
717
+ "schema": {
718
+ "type": "string"
719
+ }
720
+ }
721
+ ],
722
+ "requestBody": {
723
+ "description": "body",
724
+ "content": {
725
+ "text/plain": {
726
+ "schema": {
727
+ "type": "string",
728
+ "description": "body"
729
+ }
730
+ }
731
+ },
732
+ "required": false
733
+ },
734
+ "responses": {
735
+ "200": {
736
+ "description": "successful operation",
737
+ "headers": {},
738
+ "content": {
739
+ "text/plain": {
740
+ "schema": {
741
+ "type": "string",
742
+ "description": "successful operation"
743
+ }
744
+ }
745
+ }
746
+ },
747
+ "400": {
748
+ "description": "failed operation"
749
+ }
750
+ },
751
+ "deprecated": false
752
+ }
753
+ },
754
+ "/subnets/{id}/all_subnets/{mask}": {
755
+ "get": {
756
+ "tags": [
757
+ "subnets"
758
+ ],
759
+ "summary": "getSubnetAllAvailable",
760
+ "description": "Returns all available subnets within selected for mask",
761
+ "operationId": "getSubnetAllAvailable",
762
+ "parameters": [
763
+ {
764
+ "name": "id",
765
+ "in": "path",
766
+ "description": "Subnet identifier, identifies which subnetto work on",
767
+ "required": true,
768
+ "style": "simple",
769
+ "schema": {
770
+ "type": "string"
771
+ }
772
+ },
773
+ {
774
+ "name": "mask",
775
+ "in": "path",
776
+ "description": "Subnet bitmask",
777
+ "required": true,
778
+ "style": "simple",
779
+ "schema": {
780
+ "type": "string"
781
+ }
782
+ }
783
+ ],
784
+ "responses": {
785
+ "200": {
786
+ "description": "successful operation",
787
+ "headers": {},
788
+ "content": {
789
+ "text/plain": {
790
+ "schema": {
791
+ "type": "string",
792
+ "description": "successful operation"
793
+ }
794
+ }
795
+ }
796
+ },
797
+ "400": {
798
+ "description": "failed operation"
799
+ }
800
+ },
801
+ "deprecated": false
802
+ }
803
+ },
804
+ "/subnets/custom_fields": {
805
+ "get": {
806
+ "tags": [
807
+ "subnets"
808
+ ],
809
+ "summary": "getSubnetCustomFields",
810
+ "description": "Returns all subnet custom fields",
811
+ "operationId": "getSubnetCustomFields",
812
+ "parameters": [],
813
+ "responses": {
814
+ "200": {
815
+ "description": "successful operation",
816
+ "headers": {},
817
+ "content": {
818
+ "text/plain": {
819
+ "schema": {
820
+ "type": "string",
821
+ "description": "successful operation"
822
+ }
823
+ }
824
+ }
825
+ },
826
+ "400": {
827
+ "description": "failed operation"
828
+ }
829
+ },
830
+ "deprecated": false
831
+ }
832
+ },
833
+ "/subnets/cidr/{subnet}": {
834
+ "get": {
835
+ "tags": [
836
+ "subnets"
837
+ ],
838
+ "summary": "getSubnetCIDR",
839
+ "description": "Searches for subnet in CIDR format",
840
+ "operationId": "getSubnetCIDR",
841
+ "parameters": [
842
+ {
843
+ "name": "subnet",
844
+ "in": "path",
845
+ "description": "IP address of subnet in dotted format (e.g. 10.10.10.0)",
846
+ "required": true,
847
+ "style": "simple",
848
+ "schema": {
849
+ "type": "string"
850
+ }
851
+ }
852
+ ],
853
+ "responses": {
854
+ "200": {
855
+ "description": "successful operation",
856
+ "headers": {},
857
+ "content": {
858
+ "text/plain": {
859
+ "schema": {
860
+ "type": "string",
861
+ "description": "successful operation"
862
+ }
863
+ }
864
+ }
865
+ },
866
+ "400": {
867
+ "description": "failed operation"
868
+ }
869
+ },
870
+ "deprecated": false
871
+ }
872
+ },
873
+ "/subnets/search/{subnet}": {
874
+ "get": {
875
+ "tags": [
876
+ "subnets"
877
+ ],
878
+ "summary": "getSubnetCIDRSearch",
879
+ "description": "Searches for subnet in CIDR format",
880
+ "operationId": "getSubnetCIDRSearch",
881
+ "parameters": [
882
+ {
883
+ "name": "subnet",
884
+ "in": "path",
885
+ "description": "IP address of subnet in dotted format (e.g. 10.10.10.0)",
886
+ "required": true,
887
+ "style": "simple",
888
+ "schema": {
889
+ "type": "string"
890
+ }
891
+ }
892
+ ],
893
+ "responses": {
894
+ "200": {
895
+ "description": "successful operation",
896
+ "headers": {},
897
+ "content": {
898
+ "text/plain": {
899
+ "schema": {
900
+ "type": "string",
901
+ "description": "successful operation"
902
+ }
903
+ }
904
+ }
905
+ },
906
+ "400": {
907
+ "description": "failed operation"
908
+ }
909
+ },
910
+ "deprecated": false
911
+ }
912
+ },
913
+ "/subnets": {
914
+ "post": {
915
+ "tags": [
916
+ "subnets"
917
+ ],
918
+ "summary": "createSubnet",
919
+ "description": "Creates new subnet",
920
+ "operationId": "createSubnet",
921
+ "parameters": [],
922
+ "requestBody": {
923
+ "description": "body",
924
+ "content": {
925
+ "text/plain": {
926
+ "schema": {
927
+ "type": "string",
928
+ "description": "body"
929
+ }
930
+ }
931
+ },
932
+ "required": false
933
+ },
934
+ "responses": {
935
+ "200": {
936
+ "description": "successful operation",
937
+ "headers": {},
938
+ "content": {
939
+ "text/plain": {
940
+ "schema": {
941
+ "type": "string",
942
+ "description": "successful operation"
943
+ }
944
+ }
945
+ }
946
+ },
947
+ "400": {
948
+ "description": "failed operation"
949
+ }
950
+ },
951
+ "deprecated": false
952
+ },
953
+ "patch": {
954
+ "tags": [
955
+ "subnets"
956
+ ],
957
+ "summary": "updateSubnet",
958
+ "description": "Updates Subnet",
959
+ "operationId": "updateSubnet",
960
+ "parameters": [],
961
+ "requestBody": {
962
+ "description": "body",
963
+ "content": {
964
+ "text/plain": {
965
+ "schema": {
966
+ "type": "string",
967
+ "description": "body"
968
+ }
969
+ }
970
+ },
971
+ "required": false
972
+ },
973
+ "responses": {
974
+ "200": {
975
+ "description": "successful operation",
976
+ "headers": {},
977
+ "content": {
978
+ "text/plain": {
979
+ "schema": {
980
+ "type": "string",
981
+ "description": "successful operation"
982
+ }
983
+ }
984
+ }
985
+ },
986
+ "400": {
987
+ "description": "failed operation"
988
+ }
989
+ },
990
+ "deprecated": false
991
+ }
992
+ },
993
+ "/subnets/{id}/resize": {
994
+ "patch": {
995
+ "tags": [
996
+ "subnets"
997
+ ],
998
+ "summary": "updateSubnetMaskSize",
999
+ "description": "Resizes subnet to new mask",
1000
+ "operationId": "updateSubnetMaskSize",
1001
+ "parameters": [
1002
+ {
1003
+ "name": "id",
1004
+ "in": "path",
1005
+ "description": "Subnet identifier, identifies which subnetto work on.",
1006
+ "required": true,
1007
+ "style": "simple",
1008
+ "schema": {
1009
+ "type": "string"
1010
+ }
1011
+ }
1012
+ ],
1013
+ "requestBody": {
1014
+ "description": "body",
1015
+ "content": {
1016
+ "text/plain": {
1017
+ "schema": {
1018
+ "type": "string",
1019
+ "description": "body"
1020
+ }
1021
+ }
1022
+ },
1023
+ "required": false
1024
+ },
1025
+ "responses": {
1026
+ "200": {
1027
+ "description": "successful operation",
1028
+ "headers": {},
1029
+ "content": {
1030
+ "text/plain": {
1031
+ "schema": {
1032
+ "type": "string",
1033
+ "description": "successful operation"
1034
+ }
1035
+ }
1036
+ }
1037
+ },
1038
+ "400": {
1039
+ "description": "failed operation"
1040
+ }
1041
+ },
1042
+ "deprecated": false
1043
+ }
1044
+ },
1045
+ "/subnets/{id}/split": {
1046
+ "patch": {
1047
+ "tags": [
1048
+ "subnets"
1049
+ ],
1050
+ "summary": "updateSubnetSplit",
1051
+ "description": "Splits subnet to smaller subnets",
1052
+ "operationId": "updateSubnetSplit",
1053
+ "parameters": [
1054
+ {
1055
+ "name": "id",
1056
+ "in": "path",
1057
+ "description": "Subnet identifier, identifies which subnetto work on.",
1058
+ "required": true,
1059
+ "style": "simple",
1060
+ "schema": {
1061
+ "type": "string"
1062
+ }
1063
+ }
1064
+ ],
1065
+ "requestBody": {
1066
+ "description": "body",
1067
+ "content": {
1068
+ "text/plain": {
1069
+ "schema": {
1070
+ "type": "string",
1071
+ "description": "body"
1072
+ }
1073
+ }
1074
+ },
1075
+ "required": false
1076
+ },
1077
+ "responses": {
1078
+ "200": {
1079
+ "description": "successful operation",
1080
+ "headers": {},
1081
+ "content": {
1082
+ "text/plain": {
1083
+ "schema": {
1084
+ "type": "string",
1085
+ "description": "successful operation"
1086
+ }
1087
+ }
1088
+ }
1089
+ },
1090
+ "400": {
1091
+ "description": "failed operation"
1092
+ }
1093
+ },
1094
+ "deprecated": false
1095
+ }
1096
+ },
1097
+ "/subnets/{id}/permissions": {
1098
+ "patch": {
1099
+ "tags": [
1100
+ "subnets"
1101
+ ],
1102
+ "summary": "udpateSubnetPermissions",
1103
+ "description": "Sets subnet permissions (?grouname1=ro&groupname2=3&43=1)",
1104
+ "operationId": "udpateSubnetPermissions",
1105
+ "parameters": [
1106
+ {
1107
+ "name": "id",
1108
+ "in": "path",
1109
+ "description": "Subnet identifier, identifies which subnetto work on.",
1110
+ "required": true,
1111
+ "style": "simple",
1112
+ "schema": {
1113
+ "type": "string"
1114
+ }
1115
+ }
1116
+ ],
1117
+ "requestBody": {
1118
+ "description": "body",
1119
+ "content": {
1120
+ "text/plain": {
1121
+ "schema": {
1122
+ "type": "string",
1123
+ "description": "body"
1124
+ }
1125
+ }
1126
+ },
1127
+ "required": false
1128
+ },
1129
+ "responses": {
1130
+ "200": {
1131
+ "description": "successful operation",
1132
+ "headers": {},
1133
+ "content": {
1134
+ "text/plain": {
1135
+ "schema": {
1136
+ "type": "string",
1137
+ "description": "successful operation"
1138
+ }
1139
+ }
1140
+ }
1141
+ },
1142
+ "400": {
1143
+ "description": "failed operation"
1144
+ }
1145
+ },
1146
+ "deprecated": false
1147
+ },
1148
+ "delete": {
1149
+ "tags": [
1150
+ "subnets"
1151
+ ],
1152
+ "summary": "deleteSubnetPermissions",
1153
+ "description": "Removes all permissions",
1154
+ "operationId": "deleteSubnetPermissions",
1155
+ "parameters": [
1156
+ {
1157
+ "name": "id",
1158
+ "in": "path",
1159
+ "description": "Subnet identifier, identifies which subnetto work on.",
1160
+ "required": true,
1161
+ "style": "simple",
1162
+ "schema": {
1163
+ "type": "string"
1164
+ }
1165
+ }
1166
+ ],
1167
+ "responses": {
1168
+ "200": {
1169
+ "description": "successful operation",
1170
+ "headers": {},
1171
+ "content": {
1172
+ "text/plain": {
1173
+ "schema": {
1174
+ "type": "string",
1175
+ "description": "successful operation"
1176
+ }
1177
+ }
1178
+ }
1179
+ },
1180
+ "400": {
1181
+ "description": "failed operation"
1182
+ }
1183
+ },
1184
+ "deprecated": false
1185
+ }
1186
+ },
1187
+ "/subnets/{id}/truncate": {
1188
+ "delete": {
1189
+ "tags": [
1190
+ "subnets"
1191
+ ],
1192
+ "summary": "deleteSubnetAddresses",
1193
+ "description": "Removes all addresses from subnet",
1194
+ "operationId": "deleteSubnetAddresses",
1195
+ "parameters": [
1196
+ {
1197
+ "name": "id",
1198
+ "in": "path",
1199
+ "description": "Subnet identifier, identifies which subnetto work on.",
1200
+ "required": true,
1201
+ "style": "simple",
1202
+ "schema": {
1203
+ "type": "string"
1204
+ }
1205
+ }
1206
+ ],
1207
+ "responses": {
1208
+ "200": {
1209
+ "description": "successful operation",
1210
+ "headers": {},
1211
+ "content": {
1212
+ "text/plain": {
1213
+ "schema": {
1214
+ "type": "string",
1215
+ "description": "successful operation"
1216
+ }
1217
+ }
1218
+ }
1219
+ },
1220
+ "400": {
1221
+ "description": "failed operation"
1222
+ }
1223
+ },
1224
+ "deprecated": false
1225
+ }
1226
+ },
1227
+ "/devices": {
1228
+ "get": {
1229
+ "tags": [
1230
+ "devices"
1231
+ ],
1232
+ "summary": "getDevices",
1233
+ "description": "Returns all devices",
1234
+ "operationId": "getDevices",
1235
+ "parameters": [],
1236
+ "responses": {
1237
+ "200": {
1238
+ "description": "successful operation",
1239
+ "headers": {},
1240
+ "content": {
1241
+ "text/plain": {
1242
+ "schema": {
1243
+ "type": "string",
1244
+ "description": "successful operation"
1245
+ }
1246
+ }
1247
+ }
1248
+ },
1249
+ "400": {
1250
+ "description": "failed operation"
1251
+ }
1252
+ },
1253
+ "deprecated": false
1254
+ },
1255
+ "post": {
1256
+ "tags": [
1257
+ "devices"
1258
+ ],
1259
+ "summary": "createDevice",
1260
+ "description": "Creates new device",
1261
+ "operationId": "createDevice",
1262
+ "parameters": [],
1263
+ "requestBody": {
1264
+ "description": "body",
1265
+ "content": {
1266
+ "text/plain": {
1267
+ "schema": {
1268
+ "type": "string",
1269
+ "description": "body"
1270
+ }
1271
+ }
1272
+ },
1273
+ "required": false
1274
+ },
1275
+ "responses": {
1276
+ "200": {
1277
+ "description": "successful operation",
1278
+ "headers": {},
1279
+ "content": {
1280
+ "text/plain": {
1281
+ "schema": {
1282
+ "type": "string",
1283
+ "description": "successful operation"
1284
+ }
1285
+ }
1286
+ }
1287
+ },
1288
+ "400": {
1289
+ "description": "failed operation"
1290
+ }
1291
+ },
1292
+ "deprecated": false
1293
+ },
1294
+ "patch": {
1295
+ "tags": [
1296
+ "devices"
1297
+ ],
1298
+ "summary": "updateDevice",
1299
+ "description": "Updates device",
1300
+ "operationId": "updateDevice",
1301
+ "parameters": [],
1302
+ "requestBody": {
1303
+ "description": "body",
1304
+ "content": {
1305
+ "text/plain": {
1306
+ "schema": {
1307
+ "type": "string",
1308
+ "description": "body"
1309
+ }
1310
+ }
1311
+ },
1312
+ "required": false
1313
+ },
1314
+ "responses": {
1315
+ "200": {
1316
+ "description": "successful operation",
1317
+ "headers": {},
1318
+ "content": {
1319
+ "text/plain": {
1320
+ "schema": {
1321
+ "type": "string",
1322
+ "description": "successful operation"
1323
+ }
1324
+ }
1325
+ }
1326
+ },
1327
+ "400": {
1328
+ "description": "failed operation"
1329
+ }
1330
+ },
1331
+ "deprecated": false
1332
+ }
1333
+ },
1334
+ "/devices/{id}": {
1335
+ "get": {
1336
+ "tags": [
1337
+ "devices"
1338
+ ],
1339
+ "summary": "getDevice",
1340
+ "description": "Returns specific device",
1341
+ "operationId": "getDevice",
1342
+ "parameters": [
1343
+ {
1344
+ "name": "id",
1345
+ "in": "path",
1346
+ "description": "Device identifier",
1347
+ "required": true,
1348
+ "style": "simple",
1349
+ "schema": {
1350
+ "type": "string"
1351
+ }
1352
+ }
1353
+ ],
1354
+ "responses": {
1355
+ "200": {
1356
+ "description": "successful operation",
1357
+ "headers": {},
1358
+ "content": {
1359
+ "text/plain": {
1360
+ "schema": {
1361
+ "type": "string",
1362
+ "description": "successful operation"
1363
+ }
1364
+ }
1365
+ }
1366
+ },
1367
+ "400": {
1368
+ "description": "failed operation"
1369
+ }
1370
+ },
1371
+ "deprecated": false
1372
+ },
1373
+ "delete": {
1374
+ "tags": [
1375
+ "devices"
1376
+ ],
1377
+ "summary": "deleteDevice",
1378
+ "description": "Deletes device",
1379
+ "operationId": "deleteDevice",
1380
+ "parameters": [
1381
+ {
1382
+ "name": "id",
1383
+ "in": "path",
1384
+ "description": "Device identifier",
1385
+ "required": true,
1386
+ "style": "simple",
1387
+ "schema": {
1388
+ "type": "string"
1389
+ }
1390
+ }
1391
+ ],
1392
+ "responses": {
1393
+ "200": {
1394
+ "description": "successful operation",
1395
+ "headers": {},
1396
+ "content": {
1397
+ "text/plain": {
1398
+ "schema": {
1399
+ "type": "string",
1400
+ "description": "successful operation"
1401
+ }
1402
+ }
1403
+ }
1404
+ },
1405
+ "400": {
1406
+ "description": "failed operation"
1407
+ }
1408
+ },
1409
+ "deprecated": false
1410
+ }
1411
+ },
1412
+ "/devices/{id}/subnets": {
1413
+ "get": {
1414
+ "tags": [
1415
+ "devices"
1416
+ ],
1417
+ "summary": "getDeviceSubnets",
1418
+ "description": "Returns all subnets within device",
1419
+ "operationId": "getDeviceSubnets",
1420
+ "parameters": [
1421
+ {
1422
+ "name": "id",
1423
+ "in": "path",
1424
+ "description": "Device identifier",
1425
+ "required": true,
1426
+ "style": "simple",
1427
+ "schema": {
1428
+ "type": "string"
1429
+ }
1430
+ }
1431
+ ],
1432
+ "responses": {
1433
+ "200": {
1434
+ "description": "successful operation",
1435
+ "headers": {},
1436
+ "content": {
1437
+ "text/plain": {
1438
+ "schema": {
1439
+ "type": "string",
1440
+ "description": "successful operation"
1441
+ }
1442
+ }
1443
+ }
1444
+ },
1445
+ "400": {
1446
+ "description": "failed operation"
1447
+ }
1448
+ },
1449
+ "deprecated": false
1450
+ }
1451
+ },
1452
+ "/devices/{id}/addresses": {
1453
+ "get": {
1454
+ "tags": [
1455
+ "devices"
1456
+ ],
1457
+ "summary": "getDeviceAddresses",
1458
+ "description": "Returns all addresses within device",
1459
+ "operationId": "getDeviceAddresses",
1460
+ "parameters": [
1461
+ {
1462
+ "name": "id",
1463
+ "in": "path",
1464
+ "description": "Device identifier",
1465
+ "required": true,
1466
+ "style": "simple",
1467
+ "schema": {
1468
+ "type": "string"
1469
+ }
1470
+ }
1471
+ ],
1472
+ "responses": {
1473
+ "200": {
1474
+ "description": "successful operation",
1475
+ "headers": {},
1476
+ "content": {
1477
+ "text/plain": {
1478
+ "schema": {
1479
+ "type": "string",
1480
+ "description": "successful operation"
1481
+ }
1482
+ }
1483
+ }
1484
+ },
1485
+ "400": {
1486
+ "description": "failed operation"
1487
+ }
1488
+ },
1489
+ "deprecated": false
1490
+ }
1491
+ },
1492
+ "/devices/search/{search_string}": {
1493
+ "get": {
1494
+ "tags": [
1495
+ "devices"
1496
+ ],
1497
+ "summary": "getDevicesBySearchString",
1498
+ "description": "Searches for devices with {search_string} in any belonging field",
1499
+ "operationId": "getDevicesBySearchString",
1500
+ "parameters": [
1501
+ {
1502
+ "name": "search_string",
1503
+ "in": "path",
1504
+ "description": "search string",
1505
+ "required": true,
1506
+ "style": "simple",
1507
+ "schema": {
1508
+ "type": "string"
1509
+ }
1510
+ }
1511
+ ],
1512
+ "responses": {
1513
+ "200": {
1514
+ "description": "successful operation",
1515
+ "headers": {},
1516
+ "content": {
1517
+ "text/plain": {
1518
+ "schema": {
1519
+ "type": "string",
1520
+ "description": "successful operation"
1521
+ }
1522
+ }
1523
+ }
1524
+ },
1525
+ "400": {
1526
+ "description": "failed operation"
1527
+ }
1528
+ },
1529
+ "deprecated": false
1530
+ }
1531
+ },
1532
+ "/addresses/{id}": {
1533
+ "get": {
1534
+ "tags": [
1535
+ "addresses"
1536
+ ],
1537
+ "summary": "getAddress",
1538
+ "description": "Returns specific address",
1539
+ "operationId": "getAddress",
1540
+ "parameters": [
1541
+ {
1542
+ "name": "id",
1543
+ "in": "path",
1544
+ "description": "address identifier, identifies which addressto work on.",
1545
+ "required": true,
1546
+ "style": "simple",
1547
+ "schema": {
1548
+ "type": "string"
1549
+ }
1550
+ }
1551
+ ],
1552
+ "responses": {
1553
+ "200": {
1554
+ "description": "successful operation",
1555
+ "headers": {},
1556
+ "content": {
1557
+ "text/plain": {
1558
+ "schema": {
1559
+ "type": "string",
1560
+ "description": "successful operation"
1561
+ }
1562
+ }
1563
+ }
1564
+ },
1565
+ "400": {
1566
+ "description": "failed operation"
1567
+ }
1568
+ },
1569
+ "deprecated": false
1570
+ },
1571
+ "patch": {
1572
+ "tags": [
1573
+ "addresses"
1574
+ ],
1575
+ "summary": "updateAddress",
1576
+ "description": "Updates address",
1577
+ "operationId": "updateAddress",
1578
+ "parameters": [
1579
+ {
1580
+ "name": "id",
1581
+ "in": "path",
1582
+ "description": "",
1583
+ "required": true,
1584
+ "style": "simple",
1585
+ "schema": {
1586
+ "type": "string"
1587
+ }
1588
+ }
1589
+ ],
1590
+ "requestBody": {
1591
+ "description": "body",
1592
+ "content": {
1593
+ "text/plain": {
1594
+ "schema": {
1595
+ "type": "string",
1596
+ "description": "body"
1597
+ }
1598
+ }
1599
+ },
1600
+ "required": false
1601
+ },
1602
+ "responses": {
1603
+ "200": {
1604
+ "description": "successful operation",
1605
+ "headers": {},
1606
+ "content": {
1607
+ "text/plain": {
1608
+ "schema": {
1609
+ "type": "string",
1610
+ "description": "successful operation"
1611
+ }
1612
+ }
1613
+ }
1614
+ },
1615
+ "400": {
1616
+ "description": "failed operation"
1617
+ }
1618
+ },
1619
+ "deprecated": false
1620
+ },
1621
+ "delete": {
1622
+ "tags": [
1623
+ "addresses"
1624
+ ],
1625
+ "summary": "deleteAddress",
1626
+ "description": "Deletes address - use 'remove_dns=1' parameter to remove all related DNS records",
1627
+ "operationId": "deleteAddress",
1628
+ "parameters": [
1629
+ {
1630
+ "name": "id",
1631
+ "in": "path",
1632
+ "description": "id",
1633
+ "required": true,
1634
+ "style": "simple",
1635
+ "schema": {
1636
+ "type": "string"
1637
+ }
1638
+ }
1639
+ ],
1640
+ "responses": {
1641
+ "200": {
1642
+ "description": "successful operation",
1643
+ "headers": {},
1644
+ "content": {
1645
+ "text/plain": {
1646
+ "schema": {
1647
+ "type": "string",
1648
+ "description": "successful operation"
1649
+ }
1650
+ }
1651
+ }
1652
+ },
1653
+ "400": {
1654
+ "description": "failed operation"
1655
+ }
1656
+ },
1657
+ "deprecated": false
1658
+ }
1659
+ },
1660
+ "/addresses/{id}/ping": {
1661
+ "get": {
1662
+ "tags": [
1663
+ "addresses"
1664
+ ],
1665
+ "summary": "getAddressStatus",
1666
+ "description": "Checks address status",
1667
+ "operationId": "getAddressStatus",
1668
+ "parameters": [
1669
+ {
1670
+ "name": "id",
1671
+ "in": "path",
1672
+ "description": "address identifier, identifies which addressto work on.",
1673
+ "required": true,
1674
+ "style": "simple",
1675
+ "schema": {
1676
+ "type": "string"
1677
+ }
1678
+ }
1679
+ ],
1680
+ "responses": {
1681
+ "200": {
1682
+ "description": "successful operation",
1683
+ "headers": {},
1684
+ "content": {
1685
+ "text/plain": {
1686
+ "schema": {
1687
+ "type": "string",
1688
+ "description": "successful operation"
1689
+ }
1690
+ }
1691
+ }
1692
+ },
1693
+ "400": {
1694
+ "description": "failed operation"
1695
+ }
1696
+ },
1697
+ "deprecated": false
1698
+ }
1699
+ },
1700
+ "/addresses/{ip}/{subnetId}": {
1701
+ "get": {
1702
+ "tags": [
1703
+ "addresses"
1704
+ ],
1705
+ "summary": "getAddressFromSubnet",
1706
+ "description": "Returns address from subnet by ip address",
1707
+ "operationId": "getAddressFromSubnet",
1708
+ "parameters": [
1709
+ {
1710
+ "name": "ip",
1711
+ "in": "path",
1712
+ "description": "IP address",
1713
+ "required": true,
1714
+ "style": "simple",
1715
+ "schema": {
1716
+ "type": "string"
1717
+ }
1718
+ },
1719
+ {
1720
+ "name": "subnetId",
1721
+ "in": "path",
1722
+ "description": "Id of subnet address belongs to",
1723
+ "required": true,
1724
+ "style": "simple",
1725
+ "schema": {
1726
+ "type": "string"
1727
+ }
1728
+ }
1729
+ ],
1730
+ "responses": {
1731
+ "200": {
1732
+ "description": "successful operation",
1733
+ "headers": {},
1734
+ "content": {
1735
+ "text/plain": {
1736
+ "schema": {
1737
+ "type": "string",
1738
+ "description": "successful operation"
1739
+ }
1740
+ }
1741
+ }
1742
+ },
1743
+ "400": {
1744
+ "description": "failed operation"
1745
+ }
1746
+ },
1747
+ "deprecated": false
1748
+ },
1749
+ "delete": {
1750
+ "tags": [
1751
+ "addresses"
1752
+ ],
1753
+ "summary": "deleteAddressInSubnet",
1754
+ "description": "Deletes address by IP in specific subnet",
1755
+ "operationId": "deleteAddressInSubnet",
1756
+ "parameters": [
1757
+ {
1758
+ "name": "ip",
1759
+ "in": "path",
1760
+ "description": "IP address",
1761
+ "required": true,
1762
+ "style": "simple",
1763
+ "schema": {
1764
+ "type": "string"
1765
+ }
1766
+ },
1767
+ {
1768
+ "name": "subnetId",
1769
+ "in": "path",
1770
+ "description": "Id of subnet address belongs to",
1771
+ "required": true,
1772
+ "style": "simple",
1773
+ "schema": {
1774
+ "type": "string"
1775
+ }
1776
+ }
1777
+ ],
1778
+ "responses": {
1779
+ "200": {
1780
+ "description": "successful operation",
1781
+ "headers": {},
1782
+ "content": {
1783
+ "text/plain": {
1784
+ "schema": {
1785
+ "type": "string",
1786
+ "description": "successful operation"
1787
+ }
1788
+ }
1789
+ }
1790
+ },
1791
+ "400": {
1792
+ "description": "failed operation"
1793
+ }
1794
+ },
1795
+ "deprecated": false
1796
+ }
1797
+ },
1798
+ "/addresses/search/{ip}": {
1799
+ "get": {
1800
+ "tags": [
1801
+ "addresses"
1802
+ ],
1803
+ "summary": "getAddressByIP",
1804
+ "description": "searches for addresses in database, returns multiple if found",
1805
+ "operationId": "getAddressByIP",
1806
+ "parameters": [
1807
+ {
1808
+ "name": "ip",
1809
+ "in": "path",
1810
+ "description": "IP address",
1811
+ "required": true,
1812
+ "style": "simple",
1813
+ "schema": {
1814
+ "type": "string"
1815
+ }
1816
+ }
1817
+ ],
1818
+ "responses": {
1819
+ "200": {
1820
+ "description": "successful operation",
1821
+ "headers": {},
1822
+ "content": {
1823
+ "text/plain": {
1824
+ "schema": {
1825
+ "type": "string",
1826
+ "description": "successful operation"
1827
+ }
1828
+ }
1829
+ }
1830
+ },
1831
+ "400": {
1832
+ "description": "failed operation"
1833
+ }
1834
+ },
1835
+ "deprecated": false
1836
+ }
1837
+ },
1838
+ "/addresses/search_hostname/{hostname}": {
1839
+ "get": {
1840
+ "tags": [
1841
+ "addresses"
1842
+ ],
1843
+ "summary": "getAddressByHostname",
1844
+ "description": "searches for addresses in database by hostname, returns multiple if found",
1845
+ "operationId": "getAddressByHostname",
1846
+ "parameters": [
1847
+ {
1848
+ "name": "hostname",
1849
+ "in": "path",
1850
+ "description": "Address hostname",
1851
+ "required": true,
1852
+ "style": "simple",
1853
+ "schema": {
1854
+ "type": "string"
1855
+ }
1856
+ }
1857
+ ],
1858
+ "responses": {
1859
+ "200": {
1860
+ "description": "successful operation",
1861
+ "headers": {},
1862
+ "content": {
1863
+ "text/plain": {
1864
+ "schema": {
1865
+ "type": "string",
1866
+ "description": "successful operation"
1867
+ }
1868
+ }
1869
+ }
1870
+ },
1871
+ "400": {
1872
+ "description": "failed operation"
1873
+ }
1874
+ },
1875
+ "deprecated": false
1876
+ }
1877
+ },
1878
+ "/addresses/first_free/{subnetId}": {
1879
+ "get": {
1880
+ "tags": [
1881
+ "addresses"
1882
+ ],
1883
+ "summary": "getAddressFirstFree",
1884
+ "description": "Returns first available address",
1885
+ "operationId": "getAddressFirstFree",
1886
+ "parameters": [
1887
+ {
1888
+ "name": "subnetId",
1889
+ "in": "path",
1890
+ "description": "Id of subnet address belongs to",
1891
+ "required": true,
1892
+ "style": "simple",
1893
+ "schema": {
1894
+ "type": "string"
1895
+ }
1896
+ }
1897
+ ],
1898
+ "responses": {
1899
+ "200": {
1900
+ "description": "successful operation",
1901
+ "headers": {},
1902
+ "content": {
1903
+ "text/plain": {
1904
+ "schema": {
1905
+ "type": "string",
1906
+ "description": "successful operation"
1907
+ }
1908
+ }
1909
+ }
1910
+ },
1911
+ "400": {
1912
+ "description": "failed operation"
1913
+ }
1914
+ },
1915
+ "deprecated": false
1916
+ },
1917
+ "post": {
1918
+ "tags": [
1919
+ "addresses"
1920
+ ],
1921
+ "summary": "createAddressFirstAvailable",
1922
+ "description": "Creates new address in subnets – first available",
1923
+ "operationId": "createAddressFirstAvailable",
1924
+ "parameters": [
1925
+ {
1926
+ "name": "subnetId",
1927
+ "in": "path",
1928
+ "description": "Id of subnet address belongs to",
1929
+ "required": true,
1930
+ "style": "simple",
1931
+ "schema": {
1932
+ "type": "string"
1933
+ }
1934
+ }
1935
+ ],
1936
+ "requestBody": {
1937
+ "description": "body",
1938
+ "content": {
1939
+ "text/plain": {
1940
+ "schema": {
1941
+ "type": "string",
1942
+ "description": "body"
1943
+ }
1944
+ }
1945
+ },
1946
+ "required": false
1947
+ },
1948
+ "responses": {
1949
+ "200": {
1950
+ "description": "successful operation",
1951
+ "headers": {},
1952
+ "content": {
1953
+ "text/plain": {
1954
+ "schema": {
1955
+ "type": "string",
1956
+ "description": "successful operation"
1957
+ }
1958
+ }
1959
+ }
1960
+ },
1961
+ "400": {
1962
+ "description": "failed operation"
1963
+ }
1964
+ },
1965
+ "deprecated": false
1966
+ }
1967
+ },
1968
+ "/addresses/custom_fields": {
1969
+ "get": {
1970
+ "tags": [
1971
+ "addresses"
1972
+ ],
1973
+ "summary": "getAddressCustomFields",
1974
+ "description": "Returns custom fields",
1975
+ "operationId": "getAddressCustomFields",
1976
+ "parameters": [],
1977
+ "responses": {
1978
+ "200": {
1979
+ "description": "successful operation",
1980
+ "headers": {},
1981
+ "content": {
1982
+ "text/plain": {
1983
+ "schema": {
1984
+ "type": "string",
1985
+ "description": "successful operation"
1986
+ }
1987
+ }
1988
+ }
1989
+ },
1990
+ "400": {
1991
+ "description": "failed operation"
1992
+ }
1993
+ },
1994
+ "deprecated": false
1995
+ }
1996
+ },
1997
+ "/addresses/tags": {
1998
+ "get": {
1999
+ "tags": [
2000
+ "addresses"
2001
+ ],
2002
+ "summary": "getAddressTags",
2003
+ "description": "Returns all tags",
2004
+ "operationId": "getAddressTags",
2005
+ "parameters": [],
2006
+ "responses": {
2007
+ "200": {
2008
+ "description": "successful operation",
2009
+ "headers": {},
2010
+ "content": {
2011
+ "text/plain": {
2012
+ "schema": {
2013
+ "type": "string",
2014
+ "description": "successful operation"
2015
+ }
2016
+ }
2017
+ }
2018
+ },
2019
+ "400": {
2020
+ "description": "failed operation"
2021
+ }
2022
+ },
2023
+ "deprecated": false
2024
+ }
2025
+ },
2026
+ "/addresses/tags/{id}": {
2027
+ "get": {
2028
+ "tags": [
2029
+ "addresses"
2030
+ ],
2031
+ "summary": "getSpecificTag",
2032
+ "description": "Returns specific tag",
2033
+ "operationId": "getSpecificTag",
2034
+ "parameters": [
2035
+ {
2036
+ "name": "id",
2037
+ "in": "path",
2038
+ "description": "id of tag",
2039
+ "required": true,
2040
+ "style": "simple",
2041
+ "schema": {
2042
+ "type": "string"
2043
+ }
2044
+ }
2045
+ ],
2046
+ "responses": {
2047
+ "200": {
2048
+ "description": "successful operation",
2049
+ "headers": {},
2050
+ "content": {
2051
+ "text/plain": {
2052
+ "schema": {
2053
+ "type": "string",
2054
+ "description": "successful operation"
2055
+ }
2056
+ }
2057
+ }
2058
+ },
2059
+ "400": {
2060
+ "description": "failed operation"
2061
+ }
2062
+ },
2063
+ "deprecated": false
2064
+ }
2065
+ },
2066
+ "/addresses/tags/{id}/addresses": {
2067
+ "get": {
2068
+ "tags": [
2069
+ "addresses"
2070
+ ],
2071
+ "summary": "getAddressesByTag",
2072
+ "description": "Returns addresses for specific tag",
2073
+ "operationId": "getAddressesByTag",
2074
+ "parameters": [
2075
+ {
2076
+ "name": "id",
2077
+ "in": "path",
2078
+ "description": "id of tag",
2079
+ "required": true,
2080
+ "style": "simple",
2081
+ "schema": {
2082
+ "type": "string"
2083
+ }
2084
+ }
2085
+ ],
2086
+ "responses": {
2087
+ "200": {
2088
+ "description": "successful operation",
2089
+ "headers": {},
2090
+ "content": {
2091
+ "text/plain": {
2092
+ "schema": {
2093
+ "type": "string",
2094
+ "description": "successful operation"
2095
+ }
2096
+ }
2097
+ }
2098
+ },
2099
+ "400": {
2100
+ "description": "failed operation"
2101
+ }
2102
+ },
2103
+ "deprecated": false
2104
+ }
2105
+ },
2106
+ "/addresses": {
2107
+ "post": {
2108
+ "tags": [
2109
+ "addresses"
2110
+ ],
2111
+ "summary": "createAddress",
2112
+ "description": "Creates new address",
2113
+ "operationId": "createAddress",
2114
+ "parameters": [],
2115
+ "requestBody": {
2116
+ "description": "body",
2117
+ "content": {
2118
+ "text/plain": {
2119
+ "schema": {
2120
+ "type": "string",
2121
+ "description": "body"
2122
+ }
2123
+ }
2124
+ },
2125
+ "required": false
2126
+ },
2127
+ "responses": {
2128
+ "200": {
2129
+ "description": "successful operation",
2130
+ "headers": {},
2131
+ "content": {
2132
+ "text/plain": {
2133
+ "schema": {
2134
+ "type": "string",
2135
+ "description": "successful operation"
2136
+ }
2137
+ }
2138
+ }
2139
+ },
2140
+ "400": {
2141
+ "description": "failed operation"
2142
+ }
2143
+ },
2144
+ "deprecated": false
2145
+ }
2146
+ },
2147
+ "/vlan": {
2148
+ "get": {
2149
+ "tags": [
2150
+ "vlans"
2151
+ ],
2152
+ "summary": "getVlans",
2153
+ "description": "Returns all Vlans",
2154
+ "operationId": "getVlans",
2155
+ "parameters": [],
2156
+ "responses": {
2157
+ "200": {
2158
+ "description": "successful operation",
2159
+ "headers": {},
2160
+ "content": {
2161
+ "text/plain": {
2162
+ "schema": {
2163
+ "type": "string",
2164
+ "description": "successful operation"
2165
+ }
2166
+ }
2167
+ }
2168
+ },
2169
+ "400": {
2170
+ "description": "failed operation"
2171
+ }
2172
+ },
2173
+ "deprecated": false
2174
+ },
2175
+ "post": {
2176
+ "tags": [
2177
+ "vlans"
2178
+ ],
2179
+ "summary": "createVlan",
2180
+ "description": "Creates new VLAN",
2181
+ "operationId": "createVlan",
2182
+ "parameters": [],
2183
+ "requestBody": {
2184
+ "description": "body",
2185
+ "content": {
2186
+ "text/plain": {
2187
+ "schema": {
2188
+ "type": "string",
2189
+ "description": "body"
2190
+ }
2191
+ }
2192
+ },
2193
+ "required": false
2194
+ },
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
+ }
2205
+ }
2206
+ }
2207
+ },
2208
+ "400": {
2209
+ "description": "failed operation"
2210
+ }
2211
+ },
2212
+ "deprecated": false
2213
+ },
2214
+ "patch": {
2215
+ "tags": [
2216
+ "vlans"
2217
+ ],
2218
+ "summary": "updateVlan",
2219
+ "description": "Updates VLAN",
2220
+ "operationId": "updateVlan",
2221
+ "parameters": [],
2222
+ "requestBody": {
2223
+ "description": "body",
2224
+ "content": {
2225
+ "text/plain": {
2226
+ "schema": {
2227
+ "type": "string",
2228
+ "description": "body"
2229
+ }
2230
+ }
2231
+ },
2232
+ "required": false
2233
+ },
2234
+ "responses": {
2235
+ "200": {
2236
+ "description": "successful operation",
2237
+ "headers": {},
2238
+ "content": {
2239
+ "text/plain": {
2240
+ "schema": {
2241
+ "type": "string",
2242
+ "description": "successful operation"
2243
+ }
2244
+ }
2245
+ }
2246
+ },
2247
+ "400": {
2248
+ "description": "failed operation"
2249
+ }
2250
+ },
2251
+ "deprecated": false
2252
+ }
2253
+ },
2254
+ "/vlan/{id}": {
2255
+ "get": {
2256
+ "tags": [
2257
+ "vlans"
2258
+ ],
2259
+ "summary": "getVlan",
2260
+ "description": "Returns specific vlan",
2261
+ "operationId": "getVlan",
2262
+ "parameters": [
2263
+ {
2264
+ "name": "id",
2265
+ "in": "path",
2266
+ "description": "Vlan identifier, identifies which vlan to work on.",
2267
+ "required": true,
2268
+ "style": "simple",
2269
+ "schema": {
2270
+ "type": "string"
2271
+ }
2272
+ }
2273
+ ],
2274
+ "responses": {
2275
+ "200": {
2276
+ "description": "successful operation",
2277
+ "headers": {},
2278
+ "content": {
2279
+ "text/plain": {
2280
+ "schema": {
2281
+ "type": "string",
2282
+ "description": "successful operation"
2283
+ }
2284
+ }
2285
+ }
2286
+ },
2287
+ "400": {
2288
+ "description": "failed operation"
2289
+ }
2290
+ },
2291
+ "deprecated": false
2292
+ },
2293
+ "patch": {
2294
+ "tags": [
2295
+ "vlans"
2296
+ ],
2297
+ "summary": "deleteVlan",
2298
+ "description": "Deletes VLAN",
2299
+ "operationId": "deleteVlan",
2300
+ "parameters": [
2301
+ {
2302
+ "name": "id",
2303
+ "in": "path",
2304
+ "description": "Vlan identifier, identifies which vlan to work on.",
2305
+ "required": true,
2306
+ "style": "simple",
2307
+ "schema": {
2308
+ "type": "string"
2309
+ }
2310
+ }
2311
+ ],
2312
+ "requestBody": {
2313
+ "description": "body",
2314
+ "content": {
2315
+ "text/plain": {
2316
+ "schema": {
2317
+ "type": "object",
2318
+ "description": "body"
2319
+ }
2320
+ }
2321
+ },
2322
+ "required": false
2323
+ },
2324
+ "responses": {
2325
+ "200": {
2326
+ "description": "successful operation",
2327
+ "headers": {},
2328
+ "content": {
2329
+ "text/plain": {
2330
+ "schema": {
2331
+ "type": "string",
2332
+ "description": "successful operation"
2333
+ }
2334
+ }
2335
+ }
2336
+ },
2337
+ "400": {
2338
+ "description": "failed operation"
2339
+ }
2340
+ },
2341
+ "deprecated": false
2342
+ }
2343
+ },
2344
+ "/vlan/{id}/subnets": {
2345
+ "get": {
2346
+ "tags": [
2347
+ "vlans"
2348
+ ],
2349
+ "summary": "getVlanSubnets",
2350
+ "description": "Returns all subnets attached to vlan",
2351
+ "operationId": "getVlanSubnets",
2352
+ "parameters": [
2353
+ {
2354
+ "name": "id",
2355
+ "in": "path",
2356
+ "description": "Vlan identifier, identifies which vlan to work on.",
2357
+ "required": true,
2358
+ "style": "simple",
2359
+ "schema": {
2360
+ "type": "string"
2361
+ }
2362
+ }
2363
+ ],
2364
+ "responses": {
2365
+ "200": {
2366
+ "description": "successful operation",
2367
+ "headers": {},
2368
+ "content": {
2369
+ "text/plain": {
2370
+ "schema": {
2371
+ "type": "string",
2372
+ "description": "successful operation"
2373
+ }
2374
+ }
2375
+ }
2376
+ },
2377
+ "400": {
2378
+ "description": "failed operation"
2379
+ }
2380
+ },
2381
+ "deprecated": false
2382
+ }
2383
+ },
2384
+ "/vlan/{id}/subnets/{sectionId}": {
2385
+ "get": {
2386
+ "tags": [
2387
+ "vlans"
2388
+ ],
2389
+ "summary": "getVlanSubnetsBySection",
2390
+ "description": "Returns all subnets attached to vlan in specific section",
2391
+ "operationId": "getVlanSubnetsBySection",
2392
+ "parameters": [
2393
+ {
2394
+ "name": "id",
2395
+ "in": "path",
2396
+ "description": "Vlan identifier, identifies which vlan to work on.",
2397
+ "required": true,
2398
+ "style": "simple",
2399
+ "schema": {
2400
+ "type": "string"
2401
+ }
2402
+ },
2403
+ {
2404
+ "name": "sectionId",
2405
+ "in": "path",
2406
+ "description": "Section identifier",
2407
+ "required": true,
2408
+ "style": "simple",
2409
+ "schema": {
2410
+ "type": "string"
2411
+ }
2412
+ }
2413
+ ],
2414
+ "responses": {
2415
+ "200": {
2416
+ "description": "successful operation",
2417
+ "headers": {},
2418
+ "content": {
2419
+ "text/plain": {
2420
+ "schema": {
2421
+ "type": "string",
2422
+ "description": "successful operation"
2423
+ }
2424
+ }
2425
+ }
2426
+ },
2427
+ "400": {
2428
+ "description": "failed operation"
2429
+ }
2430
+ },
2431
+ "deprecated": false
2432
+ }
2433
+ },
2434
+ "/vlan/{id}/custom_fields": {
2435
+ "get": {
2436
+ "tags": [
2437
+ "vlans"
2438
+ ],
2439
+ "summary": "getVlanCustomFields",
2440
+ "description": "Returns custom VLAN fields",
2441
+ "operationId": "getVlanCustomFields",
2442
+ "parameters": [
2443
+ {
2444
+ "name": "id",
2445
+ "in": "path",
2446
+ "description": "Vlan identifier, identifies which vlan to work on.",
2447
+ "required": true,
2448
+ "style": "simple",
2449
+ "schema": {
2450
+ "type": "string"
2451
+ }
2452
+ }
2453
+ ],
2454
+ "responses": {
2455
+ "200": {
2456
+ "description": "successful operation",
2457
+ "headers": {},
2458
+ "content": {
2459
+ "text/plain": {
2460
+ "schema": {
2461
+ "type": "string",
2462
+ "description": "successful operation"
2463
+ }
2464
+ }
2465
+ }
2466
+ },
2467
+ "400": {
2468
+ "description": "failed operation"
2469
+ }
2470
+ },
2471
+ "deprecated": false
2472
+ }
2473
+ },
2474
+ "/vlan/{id}/search/{number}": {
2475
+ "get": {
2476
+ "tags": [
2477
+ "vlans"
2478
+ ],
2479
+ "summary": "getVlanByNumber",
2480
+ "description": "Searches for VLAN",
2481
+ "operationId": "getVlanByNumber",
2482
+ "parameters": [
2483
+ {
2484
+ "name": "id",
2485
+ "in": "path",
2486
+ "description": "Vlan identifier, identifies which vlan to work on.",
2487
+ "required": true,
2488
+ "style": "simple",
2489
+ "schema": {
2490
+ "type": "string"
2491
+ }
2492
+ },
2493
+ {
2494
+ "name": "number",
2495
+ "in": "path",
2496
+ "description": "Vlan number",
2497
+ "required": true,
2498
+ "style": "simple",
2499
+ "schema": {
2500
+ "type": "string"
2501
+ }
2502
+ }
2503
+ ],
2504
+ "responses": {
2505
+ "200": {
2506
+ "description": "successful operation",
2507
+ "headers": {},
2508
+ "content": {
2509
+ "text/plain": {
2510
+ "schema": {
2511
+ "type": "string",
2512
+ "description": "successful operation"
2513
+ }
2514
+ }
2515
+ }
2516
+ },
2517
+ "400": {
2518
+ "description": "failed operation"
2519
+ }
2520
+ },
2521
+ "deprecated": false
2522
+ }
2523
+ },
2524
+ "/l2domains": {
2525
+ "get": {
2526
+ "tags": [
2527
+ "l2domains"
2528
+ ],
2529
+ "summary": "getL2Domains",
2530
+ "description": "Returns all L2 domains",
2531
+ "operationId": "getL2Domains",
2532
+ "parameters": [],
2533
+ "responses": {
2534
+ "200": {
2535
+ "description": "successful operation",
2536
+ "headers": {},
2537
+ "content": {
2538
+ "text/plain": {
2539
+ "schema": {
2540
+ "type": "string",
2541
+ "description": "successful operation"
2542
+ }
2543
+ }
2544
+ }
2545
+ },
2546
+ "400": {
2547
+ "description": "failed operation"
2548
+ }
2549
+ },
2550
+ "deprecated": false
2551
+ },
2552
+ "post": {
2553
+ "tags": [
2554
+ "l2domains"
2555
+ ],
2556
+ "summary": "createL2Domain",
2557
+ "description": "Creates new L2 domain",
2558
+ "operationId": "createL2Domain",
2559
+ "parameters": [],
2560
+ "requestBody": {
2561
+ "description": "body",
2562
+ "content": {
2563
+ "text/plain": {
2564
+ "schema": {
2565
+ "type": "string",
2566
+ "description": "body"
2567
+ }
2568
+ }
2569
+ },
2570
+ "required": false
2571
+ },
2572
+ "responses": {
2573
+ "200": {
2574
+ "description": "successful operation",
2575
+ "headers": {},
2576
+ "content": {
2577
+ "text/plain": {
2578
+ "schema": {
2579
+ "type": "string",
2580
+ "description": "successful operation"
2581
+ }
2582
+ }
2583
+ }
2584
+ },
2585
+ "400": {
2586
+ "description": "failed operation"
2587
+ }
2588
+ },
2589
+ "deprecated": false
2590
+ },
2591
+ "patch": {
2592
+ "tags": [
2593
+ "l2domains"
2594
+ ],
2595
+ "summary": "updateL2Domain",
2596
+ "description": "Updates L2 domain",
2597
+ "operationId": "updateL2Domain",
2598
+ "parameters": [],
2599
+ "requestBody": {
2600
+ "description": "body",
2601
+ "content": {
2602
+ "text/plain": {
2603
+ "schema": {
2604
+ "type": "string",
2605
+ "description": "body"
2606
+ }
2607
+ }
2608
+ },
2609
+ "required": false
2610
+ },
2611
+ "responses": {
2612
+ "200": {
2613
+ "description": "successful operation",
2614
+ "headers": {},
2615
+ "content": {
2616
+ "text/plain": {
2617
+ "schema": {
2618
+ "type": "string",
2619
+ "description": "successful operation"
2620
+ }
2621
+ }
2622
+ }
2623
+ },
2624
+ "400": {
2625
+ "description": "failed operation"
2626
+ }
2627
+ },
2628
+ "deprecated": false
2629
+ }
2630
+ },
2631
+ "/l2domains/{id}": {
2632
+ "get": {
2633
+ "tags": [
2634
+ "l2domains"
2635
+ ],
2636
+ "summary": "getL2Domain",
2637
+ "description": "Returns specific L2 domain",
2638
+ "operationId": "getL2Domain",
2639
+ "parameters": [
2640
+ {
2641
+ "name": "id",
2642
+ "in": "path",
2643
+ "description": "L2 domain identifier",
2644
+ "required": true,
2645
+ "style": "simple",
2646
+ "schema": {
2647
+ "type": "string"
2648
+ }
2649
+ }
2650
+ ],
2651
+ "responses": {
2652
+ "200": {
2653
+ "description": "successful operation",
2654
+ "headers": {},
2655
+ "content": {
2656
+ "text/plain": {
2657
+ "schema": {
2658
+ "type": "string",
2659
+ "description": "successful operation"
2660
+ }
2661
+ }
2662
+ }
2663
+ },
2664
+ "400": {
2665
+ "description": "failed operation"
2666
+ }
2667
+ },
2668
+ "deprecated": false
2669
+ }
2670
+ },
2671
+ "/l2domains/{id}/vlans": {
2672
+ "get": {
2673
+ "tags": [
2674
+ "l2domains"
2675
+ ],
2676
+ "summary": "getL2DomainVlans",
2677
+ "description": "Returns all VLANs within L2 domain",
2678
+ "operationId": "getL2DomainVlans",
2679
+ "parameters": [
2680
+ {
2681
+ "name": "id",
2682
+ "in": "path",
2683
+ "description": "L2 domain identifier",
2684
+ "required": true,
2685
+ "style": "simple",
2686
+ "schema": {
2687
+ "type": "string"
2688
+ }
2689
+ }
2690
+ ],
2691
+ "responses": {
2692
+ "200": {
2693
+ "description": "successful operation",
2694
+ "headers": {},
2695
+ "content": {
2696
+ "text/plain": {
2697
+ "schema": {
2698
+ "type": "string",
2699
+ "description": "successful operation"
2700
+ }
2701
+ }
2702
+ }
2703
+ },
2704
+ "400": {
2705
+ "description": "failed operation"
2706
+ }
2707
+ },
2708
+ "deprecated": false
2709
+ }
2710
+ },
2711
+ "/l2domains/custom_fields": {
2712
+ "get": {
2713
+ "tags": [
2714
+ "l2domains"
2715
+ ],
2716
+ "summary": "getL2DomainCustomFields",
2717
+ "description": "Returns all custom fields",
2718
+ "operationId": "getL2DomainCustomFields",
2719
+ "parameters": [],
2720
+ "responses": {
2721
+ "200": {
2722
+ "description": "successful operation",
2723
+ "headers": {},
2724
+ "content": {
2725
+ "text/plain": {
2726
+ "schema": {
2727
+ "type": "string",
2728
+ "description": "successful operation"
2729
+ }
2730
+ }
2731
+ }
2732
+ },
2733
+ "400": {
2734
+ "description": "failed operation"
2735
+ }
2736
+ },
2737
+ "deprecated": false
2738
+ }
2739
+ },
2740
+ "/l2domains{id}": {
2741
+ "delete": {
2742
+ "tags": [
2743
+ "l2domains"
2744
+ ],
2745
+ "summary": "deleteL2Domain",
2746
+ "description": "Deletes L2 domain",
2747
+ "operationId": "deleteL2Domain",
2748
+ "parameters": [
2749
+ {
2750
+ "name": "id",
2751
+ "in": "path",
2752
+ "description": "L2 domain identifier",
2753
+ "required": true,
2754
+ "style": "simple",
2755
+ "schema": {
2756
+ "type": "string"
2757
+ }
2758
+ }
2759
+ ],
2760
+ "responses": {
2761
+ "200": {
2762
+ "description": "successful operation",
2763
+ "headers": {},
2764
+ "content": {
2765
+ "text/plain": {
2766
+ "schema": {
2767
+ "type": "string",
2768
+ "description": "successful operation"
2769
+ }
2770
+ }
2771
+ }
2772
+ },
2773
+ "400": {
2774
+ "description": "failed operation"
2775
+ }
2776
+ },
2777
+ "deprecated": false
2778
+ }
2779
+ },
2780
+ "/vrf": {
2781
+ "get": {
2782
+ "tags": [
2783
+ "vrfs"
2784
+ ],
2785
+ "summary": "getVRFs",
2786
+ "description": "Returns all VRFs",
2787
+ "operationId": "getVRFs",
2788
+ "parameters": [],
2789
+ "responses": {
2790
+ "200": {
2791
+ "description": "successful operation",
2792
+ "headers": {},
2793
+ "content": {
2794
+ "text/plain": {
2795
+ "schema": {
2796
+ "type": "string",
2797
+ "description": "successful operation"
2798
+ }
2799
+ }
2800
+ }
2801
+ },
2802
+ "400": {
2803
+ "description": "failed operation"
2804
+ }
2805
+ },
2806
+ "deprecated": false
2807
+ },
2808
+ "post": {
2809
+ "tags": [
2810
+ "vrfs"
2811
+ ],
2812
+ "summary": "createVRF",
2813
+ "description": "Creates new VRF",
2814
+ "operationId": "createVRF",
2815
+ "parameters": [],
2816
+ "requestBody": {
2817
+ "description": "body",
2818
+ "content": {
2819
+ "text/plain": {
2820
+ "schema": {
2821
+ "type": "string",
2822
+ "description": "body"
2823
+ }
2824
+ }
2825
+ },
2826
+ "required": false
2827
+ },
2828
+ "responses": {
2829
+ "200": {
2830
+ "description": "successful operation",
2831
+ "headers": {},
2832
+ "content": {
2833
+ "text/plain": {
2834
+ "schema": {
2835
+ "type": "string",
2836
+ "description": "successful operation"
2837
+ }
2838
+ }
2839
+ }
2840
+ },
2841
+ "400": {
2842
+ "description": "failed operation"
2843
+ }
2844
+ },
2845
+ "deprecated": false
2846
+ },
2847
+ "patch": {
2848
+ "tags": [
2849
+ "vrfs"
2850
+ ],
2851
+ "summary": "updateVRF",
2852
+ "description": "Updates VRF",
2853
+ "operationId": "updateVRF",
2854
+ "parameters": [],
2855
+ "requestBody": {
2856
+ "description": "body",
2857
+ "content": {
2858
+ "text/plain": {
2859
+ "schema": {
2860
+ "type": "string",
2861
+ "description": "body"
2862
+ }
2863
+ }
2864
+ },
2865
+ "required": false
2866
+ },
2867
+ "responses": {
2868
+ "200": {
2869
+ "description": "successful operation",
2870
+ "headers": {},
2871
+ "content": {
2872
+ "text/plain": {
2873
+ "schema": {
2874
+ "type": "string",
2875
+ "description": "successful operation"
2876
+ }
2877
+ }
2878
+ }
2879
+ },
2880
+ "400": {
2881
+ "description": "failed operation"
2882
+ }
2883
+ },
2884
+ "deprecated": false
2885
+ }
2886
+ },
2887
+ "/vrf/{id}": {
2888
+ "get": {
2889
+ "tags": [
2890
+ "vrfs"
2891
+ ],
2892
+ "summary": "getVRF",
2893
+ "description": "Returns specific VRF",
2894
+ "operationId": "getVRF",
2895
+ "parameters": [
2896
+ {
2897
+ "name": "id",
2898
+ "in": "path",
2899
+ "description": "VRF identifier",
2900
+ "required": true,
2901
+ "style": "simple",
2902
+ "schema": {
2903
+ "type": "string"
2904
+ }
2905
+ }
2906
+ ],
2907
+ "responses": {
2908
+ "200": {
2909
+ "description": "successful operation",
2910
+ "headers": {},
2911
+ "content": {
2912
+ "text/plain": {
2913
+ "schema": {
2914
+ "type": "string",
2915
+ "description": "successful operation"
2916
+ }
2917
+ }
2918
+ }
2919
+ },
2920
+ "400": {
2921
+ "description": "failed operation"
2922
+ }
2923
+ },
2924
+ "deprecated": false
2925
+ },
2926
+ "delete": {
2927
+ "tags": [
2928
+ "vrfs"
2929
+ ],
2930
+ "summary": "deleteVRF",
2931
+ "description": "Deletes VRF",
2932
+ "operationId": "deleteVRF",
2933
+ "parameters": [
2934
+ {
2935
+ "name": "id",
2936
+ "in": "path",
2937
+ "description": "VRF identifier",
2938
+ "required": true,
2939
+ "style": "simple",
2940
+ "schema": {
2941
+ "type": "string"
2942
+ }
2943
+ }
2944
+ ],
2945
+ "responses": {
2946
+ "200": {
2947
+ "description": "successful operation",
2948
+ "headers": {},
2949
+ "content": {
2950
+ "text/plain": {
2951
+ "schema": {
2952
+ "type": "string",
2953
+ "description": "successful operation"
2954
+ }
2955
+ }
2956
+ }
2957
+ },
2958
+ "400": {
2959
+ "description": "failed operation"
2960
+ }
2961
+ },
2962
+ "deprecated": false
2963
+ }
2964
+ },
2965
+ "/vrf/{id}/subnets": {
2966
+ "get": {
2967
+ "tags": [
2968
+ "vrfs"
2969
+ ],
2970
+ "summary": "getVRFSubnets",
2971
+ "description": "Returns all subnets within VRF",
2972
+ "operationId": "getVRFSubnets",
2973
+ "parameters": [
2974
+ {
2975
+ "name": "id",
2976
+ "in": "path",
2977
+ "description": "VRF identifier",
2978
+ "required": true,
2979
+ "style": "simple",
2980
+ "schema": {
2981
+ "type": "string"
2982
+ }
2983
+ }
2984
+ ],
2985
+ "responses": {
2986
+ "200": {
2987
+ "description": "successful operation",
2988
+ "headers": {},
2989
+ "content": {
2990
+ "text/plain": {
2991
+ "schema": {
2992
+ "type": "string",
2993
+ "description": "successful operation"
2994
+ }
2995
+ }
2996
+ }
2997
+ },
2998
+ "400": {
2999
+ "description": "failed operation"
3000
+ }
3001
+ },
3002
+ "deprecated": false
3003
+ }
3004
+ },
3005
+ "/vrf/custom_fields": {
3006
+ "get": {
3007
+ "tags": [
3008
+ "vrfs"
3009
+ ],
3010
+ "summary": "getVRFCustomFields",
3011
+ "description": "Returns all custom fields",
3012
+ "operationId": "getVRFCustomFields",
3013
+ "parameters": [],
3014
+ "responses": {
3015
+ "200": {
3016
+ "description": "successful operation",
3017
+ "headers": {},
3018
+ "content": {
3019
+ "text/plain": {
3020
+ "schema": {
3021
+ "type": "string",
3022
+ "description": "successful operation"
3023
+ }
3024
+ }
3025
+ }
3026
+ },
3027
+ "400": {
3028
+ "description": "failed operation"
3029
+ }
3030
+ },
3031
+ "deprecated": false
3032
+ }
3033
+ },
3034
+ "/tools/{subcontroller}": {
3035
+ "get": {
3036
+ "tags": [
3037
+ "tools"
3038
+ ],
3039
+ "summary": "toolsGetSubcontrollers",
3040
+ "description": "Returns all subcontroller objects",
3041
+ "operationId": "toolsGetSubcontrollers",
3042
+ "parameters": [
3043
+ {
3044
+ "name": "subcontroller",
3045
+ "in": "path",
3046
+ "description": "subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)",
3047
+ "required": true,
3048
+ "style": "simple",
3049
+ "schema": {
3050
+ "type": "string"
3051
+ }
3052
+ }
3053
+ ],
3054
+ "responses": {
3055
+ "200": {
3056
+ "description": "successful operation",
3057
+ "headers": {},
3058
+ "content": {
3059
+ "text/plain": {
3060
+ "schema": {
3061
+ "type": "string",
3062
+ "description": "successful operation"
3063
+ }
3064
+ }
3065
+ }
3066
+ },
3067
+ "400": {
3068
+ "description": "failed operation"
3069
+ }
3070
+ },
3071
+ "deprecated": false
3072
+ },
3073
+ "post": {
3074
+ "tags": [
3075
+ "tools"
3076
+ ],
3077
+ "summary": "toolsCreateSubcontrollerObject",
3078
+ "description": "Creates new subcontroller object",
3079
+ "operationId": "toolsCreateSubcontrollerObject",
3080
+ "parameters": [
3081
+ {
3082
+ "name": "subcontroller",
3083
+ "in": "path",
3084
+ "description": "subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)",
3085
+ "required": true,
3086
+ "style": "simple",
3087
+ "schema": {
3088
+ "type": "string"
3089
+ }
3090
+ }
3091
+ ],
3092
+ "requestBody": {
3093
+ "description": "body",
3094
+ "content": {
3095
+ "text/plain": {
3096
+ "schema": {
3097
+ "type": "object",
3098
+ "description": "body"
3099
+ }
3100
+ }
3101
+ },
3102
+ "required": false
3103
+ },
3104
+ "responses": {
3105
+ "200": {
3106
+ "description": "successful operation",
3107
+ "headers": {},
3108
+ "content": {
3109
+ "text/plain": {
3110
+ "schema": {
3111
+ "type": "string",
3112
+ "description": "successful operation"
3113
+ }
3114
+ }
3115
+ }
3116
+ },
3117
+ "400": {
3118
+ "description": "failed operation"
3119
+ }
3120
+ },
3121
+ "deprecated": false
3122
+ }
3123
+ },
3124
+ "/tools/{subcontroller}/{identifier}": {
3125
+ "get": {
3126
+ "tags": [
3127
+ "tools"
3128
+ ],
3129
+ "summary": "toolsGetSubcontroller",
3130
+ "description": "Returns specific subcontroller object",
3131
+ "operationId": "toolsGetSubcontroller",
3132
+ "parameters": [
3133
+ {
3134
+ "name": "subcontroller",
3135
+ "in": "path",
3136
+ "description": "subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)",
3137
+ "required": true,
3138
+ "style": "simple",
3139
+ "schema": {
3140
+ "type": "string"
3141
+ }
3142
+ },
3143
+ {
3144
+ "name": "identifier",
3145
+ "in": "path",
3146
+ "description": "id",
3147
+ "required": true,
3148
+ "style": "simple",
3149
+ "schema": {
3150
+ "type": "string"
3151
+ }
3152
+ }
3153
+ ],
3154
+ "responses": {
3155
+ "200": {
3156
+ "description": "successful operation",
3157
+ "headers": {},
3158
+ "content": {
3159
+ "text/plain": {
3160
+ "schema": {
3161
+ "type": "string",
3162
+ "description": "successful operation"
3163
+ }
3164
+ }
3165
+ }
3166
+ },
3167
+ "400": {
3168
+ "description": "failed operation"
3169
+ }
3170
+ },
3171
+ "deprecated": false
3172
+ },
3173
+ "patch": {
3174
+ "tags": [
3175
+ "tools"
3176
+ ],
3177
+ "summary": "toolsUpdateSubcontrollerObject",
3178
+ "description": "Updates subcontroller object",
3179
+ "operationId": "toolsUpdateSubcontrollerObject",
3180
+ "parameters": [
3181
+ {
3182
+ "name": "subcontroller",
3183
+ "in": "path",
3184
+ "description": "subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)",
3185
+ "required": true,
3186
+ "style": "simple",
3187
+ "schema": {
3188
+ "type": "string"
3189
+ }
3190
+ },
3191
+ {
3192
+ "name": "identifier",
3193
+ "in": "path",
3194
+ "description": "id",
3195
+ "required": true,
3196
+ "style": "simple",
3197
+ "schema": {
3198
+ "type": "string"
3199
+ }
3200
+ }
3201
+ ],
3202
+ "requestBody": {
3203
+ "description": "body",
3204
+ "content": {
3205
+ "text/plain": {
3206
+ "schema": {
3207
+ "type": "string",
3208
+ "description": "body"
3209
+ }
3210
+ }
3211
+ },
3212
+ "required": false
3213
+ },
3214
+ "responses": {
3215
+ "200": {
3216
+ "description": "successful operation",
3217
+ "headers": {},
3218
+ "content": {
3219
+ "text/plain": {
3220
+ "schema": {
3221
+ "type": "string",
3222
+ "description": "successful operation"
3223
+ }
3224
+ }
3225
+ }
3226
+ },
3227
+ "400": {
3228
+ "description": "failed operation"
3229
+ }
3230
+ },
3231
+ "deprecated": false
3232
+ },
3233
+ "delete": {
3234
+ "tags": [
3235
+ "tools"
3236
+ ],
3237
+ "summary": "toolsDeleteSubcontrollerObject",
3238
+ "description": "Deletes subcontroller object",
3239
+ "operationId": "toolsDeleteSubcontrollerObject",
3240
+ "parameters": [
3241
+ {
3242
+ "name": "subcontroller",
3243
+ "in": "path",
3244
+ "description": "subcontroller (tags, devices, device_types, vlans, vrfs, nameservers, scanagents, locations, nat, racks)",
3245
+ "required": true,
3246
+ "style": "simple",
3247
+ "schema": {
3248
+ "type": "string"
3249
+ }
3250
+ },
3251
+ {
3252
+ "name": "identifier",
3253
+ "in": "path",
3254
+ "description": "id",
3255
+ "required": true,
3256
+ "style": "simple",
3257
+ "schema": {
3258
+ "type": "string"
3259
+ }
3260
+ }
3261
+ ],
3262
+ "responses": {
3263
+ "200": {
3264
+ "description": "successful operation",
3265
+ "headers": {},
3266
+ "content": {
3267
+ "text/plain": {
3268
+ "schema": {
3269
+ "type": "string",
3270
+ "description": "successful operation"
3271
+ }
3272
+ }
3273
+ }
3274
+ },
3275
+ "400": {
3276
+ "description": "failed operation"
3277
+ }
3278
+ },
3279
+ "deprecated": false
3280
+ }
3281
+ },
3282
+ "/tools/device_types/{id}": {
3283
+ "get": {
3284
+ "tags": [
3285
+ "tools"
3286
+ ],
3287
+ "summary": "toolsGetDeviceTypeDetails",
3288
+ "description": "Returns device type details",
3289
+ "operationId": "toolsGetDeviceTypeDetails",
3290
+ "parameters": [
3291
+ {
3292
+ "name": "id",
3293
+ "in": "path",
3294
+ "description": "id",
3295
+ "required": true,
3296
+ "style": "simple",
3297
+ "schema": {
3298
+ "type": "string"
3299
+ }
3300
+ }
3301
+ ],
3302
+ "responses": {
3303
+ "200": {
3304
+ "description": "successful operation",
3305
+ "headers": {},
3306
+ "content": {
3307
+ "text/plain": {
3308
+ "schema": {
3309
+ "type": "string",
3310
+ "description": "successful operation"
3311
+ }
3312
+ }
3313
+ }
3314
+ },
3315
+ "400": {
3316
+ "description": "failed operation"
3317
+ }
3318
+ },
3319
+ "deprecated": false
3320
+ }
3321
+ },
3322
+ "/tools/device_types/{id}/devices": {
3323
+ "get": {
3324
+ "tags": [
3325
+ "tools"
3326
+ ],
3327
+ "summary": "toolsGetDevicesByDeviceType",
3328
+ "description": "Returns all devices with devicetype",
3329
+ "operationId": "toolsGetDevicesByDeviceType",
3330
+ "parameters": [
3331
+ {
3332
+ "name": "id",
3333
+ "in": "path",
3334
+ "description": "id",
3335
+ "required": true,
3336
+ "style": "simple",
3337
+ "schema": {
3338
+ "type": "string"
3339
+ }
3340
+ }
3341
+ ],
3342
+ "responses": {
3343
+ "200": {
3344
+ "description": "successful operation",
3345
+ "headers": {},
3346
+ "content": {
3347
+ "text/plain": {
3348
+ "schema": {
3349
+ "type": "string",
3350
+ "description": "successful operation"
3351
+ }
3352
+ }
3353
+ }
3354
+ },
3355
+ "400": {
3356
+ "description": "failed operation"
3357
+ }
3358
+ },
3359
+ "deprecated": false
3360
+ }
3361
+ },
3362
+ "/tools/vlans/{id}/subnets": {
3363
+ "get": {
3364
+ "tags": [
3365
+ "tools"
3366
+ ],
3367
+ "summary": "toolsGetSubnetsByVLAN",
3368
+ "description": "Returns all subnets that belong to VLAN",
3369
+ "operationId": "toolsGetSubnetsByVLAN",
3370
+ "parameters": [
3371
+ {
3372
+ "name": "id",
3373
+ "in": "path",
3374
+ "description": "id",
3375
+ "required": true,
3376
+ "style": "simple",
3377
+ "schema": {
3378
+ "type": "string"
3379
+ }
3380
+ }
3381
+ ],
3382
+ "responses": {
3383
+ "200": {
3384
+ "description": "successful operation",
3385
+ "headers": {},
3386
+ "content": {
3387
+ "text/plain": {
3388
+ "schema": {
3389
+ "type": "string",
3390
+ "description": "successful operation"
3391
+ }
3392
+ }
3393
+ }
3394
+ },
3395
+ "400": {
3396
+ "description": "failed operation"
3397
+ }
3398
+ },
3399
+ "deprecated": false
3400
+ }
3401
+ },
3402
+ "/tools/vrfs/{id}/subnets": {
3403
+ "get": {
3404
+ "tags": [
3405
+ "tools"
3406
+ ],
3407
+ "summary": "toolsGetSubnetsByVRF",
3408
+ "description": "Returns all subnets that belong to VRF",
3409
+ "operationId": "toolsGetSubnetsByVRF",
3410
+ "parameters": [
3411
+ {
3412
+ "name": "id",
3413
+ "in": "path",
3414
+ "description": "id",
3415
+ "required": true,
3416
+ "style": "simple",
3417
+ "schema": {
3418
+ "type": "string"
3419
+ }
3420
+ }
3421
+ ],
3422
+ "responses": {
3423
+ "200": {
3424
+ "description": "successful operation",
3425
+ "headers": {},
3426
+ "content": {
3427
+ "text/plain": {
3428
+ "schema": {
3429
+ "type": "string",
3430
+ "description": "successful operation"
3431
+ }
3432
+ }
3433
+ }
3434
+ },
3435
+ "400": {
3436
+ "description": "failed operation"
3437
+ }
3438
+ },
3439
+ "deprecated": false
3440
+ }
3441
+ },
3442
+ "/tools/locations/{id}/subnets": {
3443
+ "get": {
3444
+ "tags": [
3445
+ "tools"
3446
+ ],
3447
+ "summary": "toolsGetSubnetsByLocation",
3448
+ "description": "Returns all subnets that belong to Location",
3449
+ "operationId": "toolsGetSubnetsByLocation",
3450
+ "parameters": [
3451
+ {
3452
+ "name": "id",
3453
+ "in": "path",
3454
+ "description": "id",
3455
+ "required": true,
3456
+ "style": "simple",
3457
+ "schema": {
3458
+ "type": "string"
3459
+ }
3460
+ }
3461
+ ],
3462
+ "responses": {
3463
+ "200": {
3464
+ "description": "successful operation",
3465
+ "headers": {},
3466
+ "content": {
3467
+ "text/plain": {
3468
+ "schema": {
3469
+ "type": "string",
3470
+ "description": "successful operation"
3471
+ }
3472
+ }
3473
+ }
3474
+ },
3475
+ "400": {
3476
+ "description": "failed operation"
3477
+ }
3478
+ },
3479
+ "deprecated": false
3480
+ }
3481
+ },
3482
+ "/tools/locations/{id}/devices": {
3483
+ "get": {
3484
+ "tags": [
3485
+ "tools"
3486
+ ],
3487
+ "summary": "toolsGetDevicesByLocation",
3488
+ "description": "Returns all devices that belong to Location",
3489
+ "operationId": "toolsGetDevicesByLocation",
3490
+ "parameters": [
3491
+ {
3492
+ "name": "id",
3493
+ "in": "path",
3494
+ "description": "id",
3495
+ "required": true,
3496
+ "style": "simple",
3497
+ "schema": {
3498
+ "type": "string"
3499
+ }
3500
+ }
3501
+ ],
3502
+ "responses": {
3503
+ "200": {
3504
+ "description": "successful operation",
3505
+ "headers": {},
3506
+ "content": {
3507
+ "text/plain": {
3508
+ "schema": {
3509
+ "type": "string",
3510
+ "description": "successful operation"
3511
+ }
3512
+ }
3513
+ }
3514
+ },
3515
+ "400": {
3516
+ "description": "failed operation"
3517
+ }
3518
+ },
3519
+ "deprecated": false
3520
+ }
3521
+ },
3522
+ "/tools/locations/{id}/racks": {
3523
+ "get": {
3524
+ "tags": [
3525
+ "tools"
3526
+ ],
3527
+ "summary": "toolsGetRacksByLocation",
3528
+ "description": "Returns all racks that belong to Location",
3529
+ "operationId": "toolsGetRacksByLocation",
3530
+ "parameters": [
3531
+ {
3532
+ "name": "id",
3533
+ "in": "path",
3534
+ "description": "id",
3535
+ "required": true,
3536
+ "style": "simple",
3537
+ "schema": {
3538
+ "type": "string"
3539
+ }
3540
+ }
3541
+ ],
3542
+ "responses": {
3543
+ "200": {
3544
+ "description": "successful operation",
3545
+ "headers": {},
3546
+ "content": {
3547
+ "text/plain": {
3548
+ "schema": {
3549
+ "type": "string",
3550
+ "description": "successful operation"
3551
+ }
3552
+ }
3553
+ }
3554
+ },
3555
+ "400": {
3556
+ "description": "failed operation"
3557
+ }
3558
+ },
3559
+ "deprecated": false
3560
+ }
3561
+ },
3562
+ "/tools/racks/{id}/devices": {
3563
+ "get": {
3564
+ "tags": [
3565
+ "tools"
3566
+ ],
3567
+ "summary": "toolsGetDevicesByRack",
3568
+ "description": "Returns all devices that belong to rack",
3569
+ "operationId": "toolsGetDevicesByRack",
3570
+ "parameters": [
3571
+ {
3572
+ "name": "id",
3573
+ "in": "path",
3574
+ "description": "id",
3575
+ "required": true,
3576
+ "style": "simple",
3577
+ "schema": {
3578
+ "type": "string"
3579
+ }
3580
+ }
3581
+ ],
3582
+ "responses": {
3583
+ "200": {
3584
+ "description": "successful operation",
3585
+ "headers": {},
3586
+ "content": {
3587
+ "text/plain": {
3588
+ "schema": {
3589
+ "type": "string",
3590
+ "description": "successful operation"
3591
+ }
3592
+ }
3593
+ }
3594
+ },
3595
+ "400": {
3596
+ "description": "failed operation"
3597
+ }
3598
+ },
3599
+ "deprecated": false
3600
+ }
3601
+ },
3602
+ "/tools/nat/{id}/objects": {
3603
+ "get": {
3604
+ "tags": [
3605
+ "tools"
3606
+ ],
3607
+ "summary": "getNATDetailsAttachedObjects",
3608
+ "description": "Returns nat details and array of all attached objects",
3609
+ "operationId": "getNATDetailsAttachedObjects",
3610
+ "parameters": [
3611
+ {
3612
+ "name": "id",
3613
+ "in": "path",
3614
+ "description": "id",
3615
+ "required": true,
3616
+ "style": "simple",
3617
+ "schema": {
3618
+ "type": "string"
3619
+ }
3620
+ }
3621
+ ],
3622
+ "responses": {
3623
+ "200": {
3624
+ "description": "successful operation",
3625
+ "headers": {},
3626
+ "content": {
3627
+ "text/plain": {
3628
+ "schema": {
3629
+ "type": "string",
3630
+ "description": "successful operation"
3631
+ }
3632
+ }
3633
+ }
3634
+ },
3635
+ "400": {
3636
+ "description": "failed operation"
3637
+ }
3638
+ },
3639
+ "deprecated": false
3640
+ }
3641
+ },
3642
+ "/tools/nat/{id}/objects_full": {
3643
+ "get": {
3644
+ "tags": [
3645
+ "tools"
3646
+ ],
3647
+ "summary": "getNATDetailsAllObjects",
3648
+ "description": "Returns nat details and full array of all attached objects",
3649
+ "operationId": "getNATDetailsAllObjects",
3650
+ "parameters": [
3651
+ {
3652
+ "name": "id",
3653
+ "in": "path",
3654
+ "description": "id",
3655
+ "required": true,
3656
+ "style": "simple",
3657
+ "schema": {
3658
+ "type": "string"
3659
+ }
3660
+ }
3661
+ ],
3662
+ "responses": {
3663
+ "200": {
3664
+ "description": "successful operation",
3665
+ "headers": {},
3666
+ "content": {
3667
+ "text/plain": {
3668
+ "schema": {
3669
+ "type": "string",
3670
+ "description": "successful operation"
3671
+ }
3672
+ }
3673
+ }
3674
+ },
3675
+ "400": {
3676
+ "description": "failed operation"
3677
+ }
3678
+ },
3679
+ "deprecated": false
3680
+ }
3681
+ },
3682
+ "/prefix/{customer_type}": {
3683
+ "get": {
3684
+ "tags": [
3685
+ "prefix"
3686
+ ],
3687
+ "summary": "prefixGetSubnetsUsedToDeliverSubnets",
3688
+ "description": "Returns all subnets used to deliver new subnets",
3689
+ "operationId": "prefixGetSubnetsUsedToDeliverSubnets",
3690
+ "parameters": [
3691
+ {
3692
+ "name": "customer_type",
3693
+ "in": "path",
3694
+ "description": "customer_type",
3695
+ "required": true,
3696
+ "style": "simple",
3697
+ "schema": {
3698
+ "type": "string"
3699
+ }
3700
+ }
3701
+ ],
3702
+ "responses": {
3703
+ "200": {
3704
+ "description": "successful operation",
3705
+ "headers": {},
3706
+ "content": {
3707
+ "text/plain": {
3708
+ "schema": {
3709
+ "type": "string",
3710
+ "description": "successful operation"
3711
+ }
3712
+ }
3713
+ }
3714
+ },
3715
+ "400": {
3716
+ "description": "failed operation"
3717
+ }
3718
+ },
3719
+ "deprecated": false
3720
+ }
3721
+ },
3722
+ "/prefix/{customer_type}/{ip_version}": {
3723
+ "get": {
3724
+ "tags": [
3725
+ "prefix"
3726
+ ],
3727
+ "summary": "prefixGetSubnetsUsedToDeliverSubnetsVersion",
3728
+ "description": "Returns all subnets used to deliver new subnets for specific IP version * ip_version can be IPv4, IPv6, v4, v6",
3729
+ "operationId": "prefixGetSubnetsUsedToDeliverSubnetsVersion",
3730
+ "parameters": [
3731
+ {
3732
+ "name": "customer_type",
3733
+ "in": "path",
3734
+ "description": "customer_type",
3735
+ "required": true,
3736
+ "style": "simple",
3737
+ "schema": {
3738
+ "type": "string"
3739
+ }
3740
+ },
3741
+ {
3742
+ "name": "ip_version",
3743
+ "in": "path",
3744
+ "description": "ip_version",
3745
+ "required": true,
3746
+ "style": "simple",
3747
+ "schema": {
3748
+ "type": "string"
3749
+ }
3750
+ }
3751
+ ],
3752
+ "responses": {
3753
+ "200": {
3754
+ "description": "successful operation",
3755
+ "headers": {},
3756
+ "content": {
3757
+ "text/plain": {
3758
+ "schema": {
3759
+ "type": "string",
3760
+ "description": "successful operation"
3761
+ }
3762
+ }
3763
+ }
3764
+ },
3765
+ "400": {
3766
+ "description": "failed operation"
3767
+ }
3768
+ },
3769
+ "deprecated": false
3770
+ }
3771
+ },
3772
+ "/prefix/{customer_type}/address": {
3773
+ "get": {
3774
+ "tags": [
3775
+ "prefix"
3776
+ ],
3777
+ "summary": "prefixGetSubnetsUsedToDeliverNewAddresses",
3778
+ "description": "Returns all subnets used to deliver new addresses",
3779
+ "operationId": "prefixGetSubnetsUsedToDeliverNewAddresses",
3780
+ "parameters": [
3781
+ {
3782
+ "name": "customer_type",
3783
+ "in": "path",
3784
+ "description": "customer_type",
3785
+ "required": true,
3786
+ "style": "simple",
3787
+ "schema": {
3788
+ "type": "string"
3789
+ }
3790
+ }
3791
+ ],
3792
+ "responses": {
3793
+ "200": {
3794
+ "description": "successful operation",
3795
+ "headers": {},
3796
+ "content": {
3797
+ "text/plain": {
3798
+ "schema": {
3799
+ "type": "string",
3800
+ "description": "successful operation"
3801
+ }
3802
+ }
3803
+ }
3804
+ },
3805
+ "400": {
3806
+ "description": "failed operation"
3807
+ }
3808
+ },
3809
+ "deprecated": false
3810
+ }
3811
+ },
3812
+ "/prefix/{customer_type}/address/{ip_version}": {
3813
+ "get": {
3814
+ "tags": [
3815
+ "prefix"
3816
+ ],
3817
+ "summary": "prefixGetSubnetsUsedToDeliverNewAddressesVersion",
3818
+ "description": "Returns all subnets used to deliver new addresses for specific IP version",
3819
+ "operationId": "prefixGetSubnetsUsedToDeliverNewAddressesVersion",
3820
+ "parameters": [
3821
+ {
3822
+ "name": "customer_type",
3823
+ "in": "path",
3824
+ "description": "customer_type",
3825
+ "required": true,
3826
+ "style": "simple",
3827
+ "schema": {
3828
+ "type": "string"
3829
+ }
3830
+ },
3831
+ {
3832
+ "name": "ip_version",
3833
+ "in": "path",
3834
+ "description": "ip_version",
3835
+ "required": true,
3836
+ "style": "simple",
3837
+ "schema": {
3838
+ "type": "string"
3839
+ }
3840
+ }
3841
+ ],
3842
+ "responses": {
3843
+ "200": {
3844
+ "description": "successful operation",
3845
+ "headers": {},
3846
+ "content": {
3847
+ "text/plain": {
3848
+ "schema": {
3849
+ "type": "string",
3850
+ "description": "successful operation"
3851
+ }
3852
+ }
3853
+ }
3854
+ },
3855
+ "400": {
3856
+ "description": "failed operation"
3857
+ }
3858
+ },
3859
+ "deprecated": false
3860
+ }
3861
+ },
3862
+ "/prefix/{customer_type}/{ip_version}/{mask}": {
3863
+ "get": {
3864
+ "tags": [
3865
+ "prefix"
3866
+ ],
3867
+ "summary": "prefixGetFirstAvailableSubnet",
3868
+ "description": "Returns first available subnet for ip version and requested mask",
3869
+ "operationId": "prefixGetFirstAvailableSubnet",
3870
+ "parameters": [
3871
+ {
3872
+ "name": "customer_type",
3873
+ "in": "path",
3874
+ "description": "customer_type",
3875
+ "required": true,
3876
+ "style": "simple",
3877
+ "schema": {
3878
+ "type": "string"
3879
+ }
3880
+ },
3881
+ {
3882
+ "name": "ip_version",
3883
+ "in": "path",
3884
+ "description": "ip_version",
3885
+ "required": true,
3886
+ "style": "simple",
3887
+ "schema": {
3888
+ "type": "string"
3889
+ }
3890
+ },
3891
+ {
3892
+ "name": "mask",
3893
+ "in": "path",
3894
+ "description": "mask",
3895
+ "required": true,
3896
+ "style": "simple",
3897
+ "schema": {
3898
+ "type": "string"
3899
+ }
3900
+ }
3901
+ ],
3902
+ "responses": {
3903
+ "200": {
3904
+ "description": "successful operation",
3905
+ "headers": {},
3906
+ "content": {
3907
+ "text/plain": {
3908
+ "schema": {
3909
+ "type": "string",
3910
+ "description": "successful operation"
3911
+ }
3912
+ }
3913
+ }
3914
+ },
3915
+ "400": {
3916
+ "description": "failed operation"
3917
+ }
3918
+ },
3919
+ "deprecated": false
3920
+ },
3921
+ "post": {
3922
+ "tags": [
3923
+ "prefix"
3924
+ ],
3925
+ "summary": "prefixPostFirstAvailableSubnet",
3926
+ "description": "Creates first available subnet for ip version and requested mask",
3927
+ "operationId": "prefixPostFirstAvailableSubnet",
3928
+ "parameters": [
3929
+ {
3930
+ "name": "customer_type",
3931
+ "in": "path",
3932
+ "description": "customer_type",
3933
+ "required": true,
3934
+ "style": "simple",
3935
+ "schema": {
3936
+ "type": "string"
3937
+ }
3938
+ },
3939
+ {
3940
+ "name": "ip_version",
3941
+ "in": "path",
3942
+ "description": "ip_version",
3943
+ "required": true,
3944
+ "style": "simple",
3945
+ "schema": {
3946
+ "type": "string"
3947
+ }
3948
+ },
3949
+ {
3950
+ "name": "mask",
3951
+ "in": "path",
3952
+ "description": "mask",
3953
+ "required": true,
3954
+ "style": "simple",
3955
+ "schema": {
3956
+ "type": "string"
3957
+ }
3958
+ }
3959
+ ],
3960
+ "requestBody": {
3961
+ "description": "body",
3962
+ "content": {
3963
+ "text/plain": {
3964
+ "schema": {
3965
+ "type": "object",
3966
+ "description": "body"
3967
+ }
3968
+ }
3969
+ },
3970
+ "required": false
3971
+ },
3972
+ "responses": {
3973
+ "200": {
3974
+ "description": "successful operation",
3975
+ "headers": {},
3976
+ "content": {
3977
+ "text/plain": {
3978
+ "schema": {
3979
+ "type": "string",
3980
+ "description": "successful operation"
3981
+ }
3982
+ }
3983
+ }
3984
+ },
3985
+ "400": {
3986
+ "description": "failed operation"
3987
+ }
3988
+ },
3989
+ "deprecated": false
3990
+ }
3991
+ },
3992
+ "/prefix/{customer_type}/{ip_version}/address": {
3993
+ "get": {
3994
+ "tags": [
3995
+ "prefix"
3996
+ ],
3997
+ "summary": "prefixGetFirstAvailableAddress",
3998
+ "description": "Returns first available address for ip version",
3999
+ "operationId": "prefixGetFirstAvailableAddress",
4000
+ "parameters": [
4001
+ {
4002
+ "name": "customer_type",
4003
+ "in": "path",
4004
+ "description": "customer_type",
4005
+ "required": true,
4006
+ "style": "simple",
4007
+ "schema": {
4008
+ "type": "string"
4009
+ }
4010
+ },
4011
+ {
4012
+ "name": "ip_version",
4013
+ "in": "path",
4014
+ "description": "ip_version",
4015
+ "required": true,
4016
+ "style": "simple",
4017
+ "schema": {
4018
+ "type": "string"
4019
+ }
4020
+ }
4021
+ ],
4022
+ "responses": {
4023
+ "200": {
4024
+ "description": "successful operation",
4025
+ "headers": {},
4026
+ "content": {
4027
+ "text/plain": {
4028
+ "schema": {
4029
+ "type": "string",
4030
+ "description": "successful operation"
4031
+ }
4032
+ }
4033
+ }
4034
+ },
4035
+ "400": {
4036
+ "description": "failed operation"
4037
+ }
4038
+ },
4039
+ "deprecated": false
4040
+ },
4041
+ "post": {
4042
+ "tags": [
4043
+ "prefix"
4044
+ ],
4045
+ "summary": "prefixPostFirstAvailableAddress",
4046
+ "description": "Creates first available address for ip version",
4047
+ "operationId": "prefixPostFirstAvailableAddress",
4048
+ "parameters": [
4049
+ {
4050
+ "name": "customer_type",
4051
+ "in": "path",
4052
+ "description": "customer_type",
4053
+ "required": true,
4054
+ "style": "simple",
4055
+ "schema": {
4056
+ "type": "string"
4057
+ }
4058
+ },
4059
+ {
4060
+ "name": "ip_version",
4061
+ "in": "path",
4062
+ "description": "ip_version",
4063
+ "required": true,
4064
+ "style": "simple",
4065
+ "schema": {
4066
+ "type": "string"
4067
+ }
4068
+ }
4069
+ ],
4070
+ "requestBody": {
4071
+ "description": "body",
4072
+ "content": {
4073
+ "text/plain": {
4074
+ "schema": {
4075
+ "type": "string",
4076
+ "description": "body"
4077
+ }
4078
+ }
4079
+ },
4080
+ "required": false
4081
+ },
4082
+ "responses": {
4083
+ "200": {
4084
+ "description": "successful operation",
4085
+ "headers": {},
4086
+ "content": {
4087
+ "text/plain": {
4088
+ "schema": {
4089
+ "type": "string",
4090
+ "description": "successful operation"
4091
+ }
4092
+ }
4093
+ }
4094
+ },
4095
+ "400": {
4096
+ "description": "failed operation"
4097
+ }
4098
+ },
4099
+ "deprecated": false
4100
+ }
4101
+ }
4102
+ },
4103
+ "tags": [
4104
+ {
4105
+ "name": "sections",
4106
+ "description": "sections controller"
4107
+ },
4108
+ {
4109
+ "name": "subnets",
4110
+ "description": "subnets controller"
4111
+ },
4112
+ {
4113
+ "name": "devices",
4114
+ "description": "devices controller"
4115
+ },
4116
+ {
4117
+ "name": "addresses",
4118
+ "description": "addresses controller"
4119
+ },
4120
+ {
4121
+ "name": "vlans",
4122
+ "description": "vlans controller"
4123
+ },
4124
+ {
4125
+ "name": "l2domains",
4126
+ "description": "l2domains controller"
4127
+ },
4128
+ {
4129
+ "name": "vrfs",
4130
+ "description": "vrfs controller"
4131
+ },
4132
+ {
4133
+ "name": "tools",
4134
+ "description": "tools controller"
4135
+ },
4136
+ {
4137
+ "name": "prefix",
4138
+ "description": "prefix controller"
4139
+ },
4140
+ {
4141
+ "name": "default",
4142
+ "description": "",
4143
+ "externalDocs": {
4144
+ "url": "http://swagger.io"
4145
+ }
4146
+ }
4147
+ ],
4148
+ "externalDocs": {
4149
+ "description": "Find out more about Swagger",
4150
+ "url": "http://swagger.io"
4151
+ }
4152
+ }