@xen-orchestra/rest-api 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1282 @@
1
+ {
2
+ "openapi": "3.0.0",
3
+ "components": {
4
+ "examples": {},
5
+ "headers": {},
6
+ "parameters": {},
7
+ "requestBodies": {},
8
+ "responses": {},
9
+ "schemas": {
10
+ "Record_string.string_": {
11
+ "properties": {},
12
+ "additionalProperties": {
13
+ "type": "string"
14
+ },
15
+ "type": "object",
16
+ "description": "Construct a type with a set of properties K of type T"
17
+ },
18
+ "Record_VM_OPERATIONS.string_": {
19
+ "properties": {
20
+ "assert_operation_valid": {
21
+ "type": "string"
22
+ },
23
+ "awaiting_memory_live": {
24
+ "type": "string"
25
+ },
26
+ "call_plugin": {
27
+ "type": "string"
28
+ },
29
+ "changing_dynamic_range": {
30
+ "type": "string"
31
+ },
32
+ "changing_memory_limits": {
33
+ "type": "string"
34
+ },
35
+ "changing_memory_live": {
36
+ "type": "string"
37
+ },
38
+ "changing_NVRAM": {
39
+ "type": "string"
40
+ },
41
+ "changing_shadow_memory": {
42
+ "type": "string"
43
+ },
44
+ "changing_shadow_memory_live": {
45
+ "type": "string"
46
+ },
47
+ "changing_static_range": {
48
+ "type": "string"
49
+ },
50
+ "changing_VCPUs": {
51
+ "type": "string"
52
+ },
53
+ "changing_VCPUs_live": {
54
+ "type": "string"
55
+ },
56
+ "checkpoint": {
57
+ "type": "string"
58
+ },
59
+ "clean_reboot": {
60
+ "type": "string"
61
+ },
62
+ "clean_shutdown": {
63
+ "type": "string"
64
+ },
65
+ "clone": {
66
+ "type": "string"
67
+ },
68
+ "copy": {
69
+ "type": "string"
70
+ },
71
+ "create_template": {
72
+ "type": "string"
73
+ },
74
+ "create_vtpm": {
75
+ "type": "string"
76
+ },
77
+ "csvm": {
78
+ "type": "string"
79
+ },
80
+ "data_source_op": {
81
+ "type": "string"
82
+ },
83
+ "destroy": {
84
+ "type": "string"
85
+ },
86
+ "export": {
87
+ "type": "string"
88
+ },
89
+ "get_boot_record": {
90
+ "type": "string"
91
+ },
92
+ "hard_reboot": {
93
+ "type": "string"
94
+ },
95
+ "hard_shutdown": {
96
+ "type": "string"
97
+ },
98
+ "import": {
99
+ "type": "string"
100
+ },
101
+ "make_into_template": {
102
+ "type": "string"
103
+ },
104
+ "metadata_export": {
105
+ "type": "string"
106
+ },
107
+ "migrate_send": {
108
+ "type": "string"
109
+ },
110
+ "pause": {
111
+ "type": "string"
112
+ },
113
+ "pool_migrate": {
114
+ "type": "string"
115
+ },
116
+ "power_state_reset": {
117
+ "type": "string"
118
+ },
119
+ "provision": {
120
+ "type": "string"
121
+ },
122
+ "query_services": {
123
+ "type": "string"
124
+ },
125
+ "resume": {
126
+ "type": "string"
127
+ },
128
+ "resume_on": {
129
+ "type": "string"
130
+ },
131
+ "revert": {
132
+ "type": "string"
133
+ },
134
+ "reverting": {
135
+ "type": "string"
136
+ },
137
+ "send_sysrq": {
138
+ "type": "string"
139
+ },
140
+ "send_trigger": {
141
+ "type": "string"
142
+ },
143
+ "shutdown": {
144
+ "type": "string"
145
+ },
146
+ "snapshot": {
147
+ "type": "string"
148
+ },
149
+ "snapshot_with_quiesce": {
150
+ "type": "string"
151
+ },
152
+ "start": {
153
+ "type": "string"
154
+ },
155
+ "start_on": {
156
+ "type": "string"
157
+ },
158
+ "suspend": {
159
+ "type": "string"
160
+ },
161
+ "unpause": {
162
+ "type": "string"
163
+ },
164
+ "update_allowed_operations": {
165
+ "type": "string"
166
+ }
167
+ },
168
+ "required": [
169
+ "assert_operation_valid",
170
+ "awaiting_memory_live",
171
+ "call_plugin",
172
+ "changing_dynamic_range",
173
+ "changing_memory_limits",
174
+ "changing_memory_live",
175
+ "changing_NVRAM",
176
+ "changing_shadow_memory",
177
+ "changing_shadow_memory_live",
178
+ "changing_static_range",
179
+ "changing_VCPUs",
180
+ "changing_VCPUs_live",
181
+ "checkpoint",
182
+ "clean_reboot",
183
+ "clean_shutdown",
184
+ "clone",
185
+ "copy",
186
+ "create_template",
187
+ "create_vtpm",
188
+ "csvm",
189
+ "data_source_op",
190
+ "destroy",
191
+ "export",
192
+ "get_boot_record",
193
+ "hard_reboot",
194
+ "hard_shutdown",
195
+ "import",
196
+ "make_into_template",
197
+ "metadata_export",
198
+ "migrate_send",
199
+ "pause",
200
+ "pool_migrate",
201
+ "power_state_reset",
202
+ "provision",
203
+ "query_services",
204
+ "resume",
205
+ "resume_on",
206
+ "revert",
207
+ "reverting",
208
+ "send_sysrq",
209
+ "send_trigger",
210
+ "shutdown",
211
+ "snapshot",
212
+ "snapshot_with_quiesce",
213
+ "start",
214
+ "start_on",
215
+ "suspend",
216
+ "unpause",
217
+ "update_allowed_operations"
218
+ ],
219
+ "type": "object",
220
+ "description": "Construct a type with a set of properties K of type T"
221
+ },
222
+ "VM_OPERATIONS": {
223
+ "type": "string",
224
+ "enum": [
225
+ "assert_operation_valid",
226
+ "awaiting_memory_live",
227
+ "call_plugin",
228
+ "changing_dynamic_range",
229
+ "changing_memory_limits",
230
+ "changing_memory_live",
231
+ "changing_NVRAM",
232
+ "changing_shadow_memory",
233
+ "changing_shadow_memory_live",
234
+ "changing_static_range",
235
+ "changing_VCPUs",
236
+ "changing_VCPUs_live",
237
+ "checkpoint",
238
+ "clean_reboot",
239
+ "clean_shutdown",
240
+ "clone",
241
+ "copy",
242
+ "create_template",
243
+ "create_vtpm",
244
+ "csvm",
245
+ "data_source_op",
246
+ "destroy",
247
+ "export",
248
+ "get_boot_record",
249
+ "hard_reboot",
250
+ "hard_shutdown",
251
+ "import",
252
+ "make_into_template",
253
+ "metadata_export",
254
+ "migrate_send",
255
+ "pause",
256
+ "pool_migrate",
257
+ "power_state_reset",
258
+ "provision",
259
+ "query_services",
260
+ "resume",
261
+ "resume_on",
262
+ "revert",
263
+ "reverting",
264
+ "send_sysrq",
265
+ "send_trigger",
266
+ "shutdown",
267
+ "snapshot",
268
+ "snapshot_with_quiesce",
269
+ "start",
270
+ "start_on",
271
+ "suspend",
272
+ "unpause",
273
+ "update_allowed_operations"
274
+ ]
275
+ },
276
+ "Record_string.VM_OPERATIONS_": {
277
+ "properties": {},
278
+ "additionalProperties": {
279
+ "$ref": "#/components/schemas/VM_OPERATIONS"
280
+ },
281
+ "type": "object",
282
+ "description": "Construct a type with a set of properties K of type T"
283
+ },
284
+ "VM_POWER_STATE": {
285
+ "type": "string",
286
+ "enum": [
287
+ "Halted",
288
+ "Paused",
289
+ "Running",
290
+ "Suspended"
291
+ ]
292
+ },
293
+ "DOMAIN_TYPE": {
294
+ "type": "string",
295
+ "enum": [
296
+ "hvm",
297
+ "pv",
298
+ "pvh",
299
+ "pv_in_pvh",
300
+ "unspecified"
301
+ ]
302
+ },
303
+ "Unbrand_XoVm_": {
304
+ "properties": {
305
+ "$VBDs": {
306
+ "items": {
307
+ "type": "string"
308
+ },
309
+ "type": "array"
310
+ },
311
+ "$VGPUs": {
312
+ "items": {
313
+ "type": "string"
314
+ },
315
+ "type": "array"
316
+ },
317
+ "$container": {
318
+ "type": "string"
319
+ },
320
+ "$pool": {
321
+ "type": "string"
322
+ },
323
+ "$poolId": {
324
+ "type": "string",
325
+ "deprecated": true
326
+ },
327
+ "_xapiRef": {
328
+ "type": "string"
329
+ },
330
+ "CPUs": {
331
+ "properties": {
332
+ "number": {
333
+ "type": "number",
334
+ "format": "double"
335
+ },
336
+ "max": {
337
+ "type": "number",
338
+ "format": "double"
339
+ }
340
+ },
341
+ "required": [
342
+ "number",
343
+ "max"
344
+ ],
345
+ "type": "object"
346
+ },
347
+ "PV_args": {
348
+ "type": "string"
349
+ },
350
+ "VGPUs": {
351
+ "items": {
352
+ "type": "string"
353
+ },
354
+ "type": "array"
355
+ },
356
+ "VIFs": {
357
+ "items": {
358
+ "type": "string"
359
+ },
360
+ "type": "array"
361
+ },
362
+ "VTPMs": {
363
+ "items": {
364
+ "type": "string"
365
+ },
366
+ "type": "array"
367
+ },
368
+ "addresses": {
369
+ "$ref": "#/components/schemas/Record_string.string_"
370
+ },
371
+ "affinityHost": {
372
+ "type": "string"
373
+ },
374
+ "attachedPcis": {
375
+ "items": {
376
+ "type": "string"
377
+ },
378
+ "type": "array"
379
+ },
380
+ "auto_poweron": {
381
+ "type": "boolean"
382
+ },
383
+ "bios_strings": {
384
+ "$ref": "#/components/schemas/Record_string.string_"
385
+ },
386
+ "blockedOperations": {
387
+ "$ref": "#/components/schemas/Record_VM_OPERATIONS.string_"
388
+ },
389
+ "boot": {
390
+ "$ref": "#/components/schemas/Record_string.string_"
391
+ },
392
+ "coresPerSocket": {
393
+ "type": "number",
394
+ "format": "double"
395
+ },
396
+ "cpuCap": {
397
+ "type": "number",
398
+ "format": "double"
399
+ },
400
+ "cpuMask": {
401
+ "items": {
402
+ "type": "number",
403
+ "format": "double"
404
+ },
405
+ "type": "array"
406
+ },
407
+ "cpuWeight": {
408
+ "type": "number",
409
+ "format": "double"
410
+ },
411
+ "creation": {
412
+ "$ref": "#/components/schemas/Record_string.string_"
413
+ },
414
+ "current_operations": {
415
+ "$ref": "#/components/schemas/Record_string.VM_OPERATIONS_"
416
+ },
417
+ "docker": {
418
+ "properties": {
419
+ "version": {
420
+ "type": "string"
421
+ },
422
+ "process": {
423
+ "type": "string"
424
+ },
425
+ "info": {
426
+ "type": "string"
427
+ },
428
+ "enabled": {
429
+ "type": "boolean"
430
+ },
431
+ "containers": {
432
+ "items": {
433
+ "type": "string"
434
+ },
435
+ "type": "array"
436
+ }
437
+ },
438
+ "required": [
439
+ "enabled"
440
+ ],
441
+ "type": "object"
442
+ },
443
+ "expNestedHvm": {
444
+ "type": "boolean"
445
+ },
446
+ "hasVendorDevice": {
447
+ "type": "boolean"
448
+ },
449
+ "high_availability": {
450
+ "type": "string"
451
+ },
452
+ "installTime": {
453
+ "type": "number",
454
+ "format": "double"
455
+ },
456
+ "isFirmwareSupported": {
457
+ "type": "boolean"
458
+ },
459
+ "memory": {
460
+ "properties": {
461
+ "usage": {
462
+ "type": "number",
463
+ "format": "double"
464
+ },
465
+ "static": {
466
+ "items": {
467
+ "type": "number",
468
+ "format": "double"
469
+ },
470
+ "type": "array"
471
+ },
472
+ "size": {
473
+ "type": "number",
474
+ "format": "double"
475
+ },
476
+ "dynamic": {
477
+ "items": {
478
+ "type": "number",
479
+ "format": "double"
480
+ },
481
+ "type": "array"
482
+ }
483
+ },
484
+ "required": [
485
+ "static",
486
+ "size",
487
+ "dynamic"
488
+ ],
489
+ "type": "object"
490
+ },
491
+ "mainIpAddress": {
492
+ "type": "string"
493
+ },
494
+ "managementAgentDetected": {
495
+ "type": "boolean"
496
+ },
497
+ "name_description": {
498
+ "type": "string"
499
+ },
500
+ "name_label": {
501
+ "type": "string"
502
+ },
503
+ "needsVtpm": {
504
+ "type": "boolean"
505
+ },
506
+ "nicType": {
507
+ "type": "string"
508
+ },
509
+ "notes": {
510
+ "type": "string"
511
+ },
512
+ "os_version": {
513
+ "$ref": "#/components/schemas/Record_string.string_"
514
+ },
515
+ "other": {
516
+ "$ref": "#/components/schemas/Record_string.string_"
517
+ },
518
+ "parent": {
519
+ "type": "string"
520
+ },
521
+ "power_state": {
522
+ "$ref": "#/components/schemas/VM_POWER_STATE"
523
+ },
524
+ "pvDriversDetected": {
525
+ "type": "boolean"
526
+ },
527
+ "pvDriversUpToDate": {
528
+ "type": "boolean"
529
+ },
530
+ "pvDriversVersion": {
531
+ "type": "string"
532
+ },
533
+ "resourceSet": {
534
+ "type": "string"
535
+ },
536
+ "secureBoot": {
537
+ "type": "boolean"
538
+ },
539
+ "snapshots": {
540
+ "items": {
541
+ "type": "string"
542
+ },
543
+ "type": "array"
544
+ },
545
+ "startDelay": {
546
+ "type": "number",
547
+ "format": "double"
548
+ },
549
+ "startTime": {
550
+ "type": "number",
551
+ "format": "double"
552
+ },
553
+ "suspendSr": {
554
+ "type": "string"
555
+ },
556
+ "tags": {
557
+ "items": {
558
+ "type": "string"
559
+ },
560
+ "type": "array"
561
+ },
562
+ "vga": {
563
+ "type": "string"
564
+ },
565
+ "videoram": {
566
+ "type": "number",
567
+ "format": "double"
568
+ },
569
+ "viridian": {
570
+ "type": "boolean"
571
+ },
572
+ "virtualizationMode": {
573
+ "$ref": "#/components/schemas/DOMAIN_TYPE"
574
+ },
575
+ "xenStoreData": {
576
+ "$ref": "#/components/schemas/Record_string.string_"
577
+ },
578
+ "xentools": {
579
+ "anyOf": [
580
+ {
581
+ "properties": {
582
+ "version": {
583
+ "type": "string"
584
+ },
585
+ "minor": {
586
+ "type": "number",
587
+ "format": "double"
588
+ },
589
+ "major": {
590
+ "type": "number",
591
+ "format": "double"
592
+ }
593
+ },
594
+ "required": [
595
+ "version",
596
+ "minor",
597
+ "major"
598
+ ],
599
+ "type": "object"
600
+ },
601
+ {
602
+ "type": "boolean",
603
+ "enum": [
604
+ false
605
+ ]
606
+ }
607
+ ],
608
+ "deprecated": true
609
+ },
610
+ "id": {
611
+ "type": "string"
612
+ },
613
+ "type": {
614
+ "type": "string",
615
+ "enum": [
616
+ "VM"
617
+ ],
618
+ "nullable": false
619
+ }
620
+ },
621
+ "required": [
622
+ "$VBDs",
623
+ "$VGPUs",
624
+ "$container",
625
+ "$pool",
626
+ "$poolId",
627
+ "_xapiRef",
628
+ "CPUs",
629
+ "VGPUs",
630
+ "VIFs",
631
+ "VTPMs",
632
+ "addresses",
633
+ "auto_poweron",
634
+ "bios_strings",
635
+ "blockedOperations",
636
+ "boot",
637
+ "creation",
638
+ "current_operations",
639
+ "expNestedHvm",
640
+ "hasVendorDevice",
641
+ "high_availability",
642
+ "isFirmwareSupported",
643
+ "memory",
644
+ "name_description",
645
+ "name_label",
646
+ "needsVtpm",
647
+ "os_version",
648
+ "other",
649
+ "power_state",
650
+ "secureBoot",
651
+ "snapshots",
652
+ "startDelay",
653
+ "tags",
654
+ "viridian",
655
+ "virtualizationMode",
656
+ "xenStoreData",
657
+ "id",
658
+ "type"
659
+ ],
660
+ "type": "object"
661
+ },
662
+ "WithHref_Unbrand_XoVm__": {
663
+ "allOf": [
664
+ {
665
+ "$ref": "#/components/schemas/Unbrand_XoVm_"
666
+ },
667
+ {
668
+ "properties": {
669
+ "href": {
670
+ "type": "string"
671
+ }
672
+ },
673
+ "required": [
674
+ "href"
675
+ ],
676
+ "type": "object"
677
+ }
678
+ ]
679
+ },
680
+ "Partial_Unbrand_XoVm__": {
681
+ "properties": {
682
+ "$VBDs": {
683
+ "items": {
684
+ "type": "string"
685
+ },
686
+ "type": "array"
687
+ },
688
+ "$VGPUs": {
689
+ "items": {
690
+ "type": "string"
691
+ },
692
+ "type": "array"
693
+ },
694
+ "$container": {
695
+ "type": "string"
696
+ },
697
+ "$pool": {
698
+ "type": "string"
699
+ },
700
+ "$poolId": {
701
+ "type": "string",
702
+ "deprecated": true
703
+ },
704
+ "_xapiRef": {
705
+ "type": "string"
706
+ },
707
+ "CPUs": {
708
+ "properties": {
709
+ "number": {
710
+ "type": "number",
711
+ "format": "double"
712
+ },
713
+ "max": {
714
+ "type": "number",
715
+ "format": "double"
716
+ }
717
+ },
718
+ "required": [
719
+ "number",
720
+ "max"
721
+ ],
722
+ "type": "object"
723
+ },
724
+ "PV_args": {
725
+ "type": "string"
726
+ },
727
+ "VGPUs": {
728
+ "items": {
729
+ "type": "string"
730
+ },
731
+ "type": "array"
732
+ },
733
+ "VIFs": {
734
+ "items": {
735
+ "type": "string"
736
+ },
737
+ "type": "array"
738
+ },
739
+ "VTPMs": {
740
+ "items": {
741
+ "type": "string"
742
+ },
743
+ "type": "array"
744
+ },
745
+ "addresses": {
746
+ "$ref": "#/components/schemas/Record_string.string_"
747
+ },
748
+ "affinityHost": {
749
+ "type": "string"
750
+ },
751
+ "attachedPcis": {
752
+ "items": {
753
+ "type": "string"
754
+ },
755
+ "type": "array"
756
+ },
757
+ "auto_poweron": {
758
+ "type": "boolean"
759
+ },
760
+ "bios_strings": {
761
+ "$ref": "#/components/schemas/Record_string.string_"
762
+ },
763
+ "blockedOperations": {
764
+ "$ref": "#/components/schemas/Record_VM_OPERATIONS.string_"
765
+ },
766
+ "boot": {
767
+ "$ref": "#/components/schemas/Record_string.string_"
768
+ },
769
+ "coresPerSocket": {
770
+ "type": "number",
771
+ "format": "double"
772
+ },
773
+ "cpuCap": {
774
+ "type": "number",
775
+ "format": "double"
776
+ },
777
+ "cpuMask": {
778
+ "items": {
779
+ "type": "number",
780
+ "format": "double"
781
+ },
782
+ "type": "array"
783
+ },
784
+ "cpuWeight": {
785
+ "type": "number",
786
+ "format": "double"
787
+ },
788
+ "creation": {
789
+ "$ref": "#/components/schemas/Record_string.string_"
790
+ },
791
+ "current_operations": {
792
+ "$ref": "#/components/schemas/Record_string.VM_OPERATIONS_"
793
+ },
794
+ "docker": {
795
+ "properties": {
796
+ "version": {
797
+ "type": "string"
798
+ },
799
+ "process": {
800
+ "type": "string"
801
+ },
802
+ "info": {
803
+ "type": "string"
804
+ },
805
+ "enabled": {
806
+ "type": "boolean"
807
+ },
808
+ "containers": {
809
+ "items": {
810
+ "type": "string"
811
+ },
812
+ "type": "array"
813
+ }
814
+ },
815
+ "required": [
816
+ "enabled"
817
+ ],
818
+ "type": "object"
819
+ },
820
+ "expNestedHvm": {
821
+ "type": "boolean"
822
+ },
823
+ "hasVendorDevice": {
824
+ "type": "boolean"
825
+ },
826
+ "high_availability": {
827
+ "type": "string"
828
+ },
829
+ "installTime": {
830
+ "type": "number",
831
+ "format": "double"
832
+ },
833
+ "isFirmwareSupported": {
834
+ "type": "boolean"
835
+ },
836
+ "memory": {
837
+ "properties": {
838
+ "usage": {
839
+ "type": "number",
840
+ "format": "double"
841
+ },
842
+ "static": {
843
+ "items": {
844
+ "type": "number",
845
+ "format": "double"
846
+ },
847
+ "type": "array"
848
+ },
849
+ "size": {
850
+ "type": "number",
851
+ "format": "double"
852
+ },
853
+ "dynamic": {
854
+ "items": {
855
+ "type": "number",
856
+ "format": "double"
857
+ },
858
+ "type": "array"
859
+ }
860
+ },
861
+ "required": [
862
+ "static",
863
+ "size",
864
+ "dynamic"
865
+ ],
866
+ "type": "object"
867
+ },
868
+ "mainIpAddress": {
869
+ "type": "string"
870
+ },
871
+ "managementAgentDetected": {
872
+ "type": "boolean"
873
+ },
874
+ "name_description": {
875
+ "type": "string"
876
+ },
877
+ "name_label": {
878
+ "type": "string"
879
+ },
880
+ "needsVtpm": {
881
+ "type": "boolean"
882
+ },
883
+ "nicType": {
884
+ "type": "string"
885
+ },
886
+ "notes": {
887
+ "type": "string"
888
+ },
889
+ "os_version": {
890
+ "$ref": "#/components/schemas/Record_string.string_"
891
+ },
892
+ "other": {
893
+ "$ref": "#/components/schemas/Record_string.string_"
894
+ },
895
+ "parent": {
896
+ "type": "string"
897
+ },
898
+ "power_state": {
899
+ "$ref": "#/components/schemas/VM_POWER_STATE"
900
+ },
901
+ "pvDriversDetected": {
902
+ "type": "boolean"
903
+ },
904
+ "pvDriversUpToDate": {
905
+ "type": "boolean"
906
+ },
907
+ "pvDriversVersion": {
908
+ "type": "string"
909
+ },
910
+ "resourceSet": {
911
+ "type": "string"
912
+ },
913
+ "secureBoot": {
914
+ "type": "boolean"
915
+ },
916
+ "snapshots": {
917
+ "items": {
918
+ "type": "string"
919
+ },
920
+ "type": "array"
921
+ },
922
+ "startDelay": {
923
+ "type": "number",
924
+ "format": "double"
925
+ },
926
+ "startTime": {
927
+ "type": "number",
928
+ "format": "double"
929
+ },
930
+ "suspendSr": {
931
+ "type": "string"
932
+ },
933
+ "tags": {
934
+ "items": {
935
+ "type": "string"
936
+ },
937
+ "type": "array"
938
+ },
939
+ "vga": {
940
+ "type": "string"
941
+ },
942
+ "videoram": {
943
+ "type": "number",
944
+ "format": "double"
945
+ },
946
+ "viridian": {
947
+ "type": "boolean"
948
+ },
949
+ "virtualizationMode": {
950
+ "$ref": "#/components/schemas/DOMAIN_TYPE"
951
+ },
952
+ "xenStoreData": {
953
+ "$ref": "#/components/schemas/Record_string.string_"
954
+ },
955
+ "xentools": {
956
+ "anyOf": [
957
+ {
958
+ "properties": {
959
+ "version": {
960
+ "type": "string"
961
+ },
962
+ "minor": {
963
+ "type": "number",
964
+ "format": "double"
965
+ },
966
+ "major": {
967
+ "type": "number",
968
+ "format": "double"
969
+ }
970
+ },
971
+ "required": [
972
+ "version",
973
+ "minor",
974
+ "major"
975
+ ],
976
+ "type": "object"
977
+ },
978
+ {
979
+ "type": "boolean",
980
+ "enum": [
981
+ false
982
+ ]
983
+ }
984
+ ],
985
+ "deprecated": true
986
+ },
987
+ "id": {
988
+ "type": "string"
989
+ },
990
+ "type": {
991
+ "type": "string",
992
+ "enum": [
993
+ "VM"
994
+ ],
995
+ "nullable": false
996
+ }
997
+ },
998
+ "type": "object",
999
+ "description": "Make all properties in T optional"
1000
+ },
1001
+ "WithHref_Partial_Unbrand_XoVm___": {
1002
+ "allOf": [
1003
+ {
1004
+ "$ref": "#/components/schemas/Partial_Unbrand_XoVm__"
1005
+ },
1006
+ {
1007
+ "properties": {
1008
+ "href": {
1009
+ "type": "string"
1010
+ }
1011
+ },
1012
+ "required": [
1013
+ "href"
1014
+ ],
1015
+ "type": "object"
1016
+ }
1017
+ ]
1018
+ }
1019
+ },
1020
+ "securitySchemes": {
1021
+ "token": {
1022
+ "type": "apiKey",
1023
+ "name": "authenticationToken",
1024
+ "in": "cookie"
1025
+ }
1026
+ }
1027
+ },
1028
+ "info": {
1029
+ "title": "@xen-orchestra/rest-api",
1030
+ "version": "0.1.0",
1031
+ "description": "REST API to manage your XOA",
1032
+ "license": {
1033
+ "name": "AGPL-3.0-or-later"
1034
+ },
1035
+ "contact": {
1036
+ "name": "Vates SAS",
1037
+ "url": "https://vates.fr"
1038
+ }
1039
+ },
1040
+ "paths": {
1041
+ "/vms": {
1042
+ "get": {
1043
+ "operationId": "GetVms",
1044
+ "responses": {
1045
+ "200": {
1046
+ "description": "Ok",
1047
+ "content": {
1048
+ "application/json": {
1049
+ "schema": {
1050
+ "anyOf": [
1051
+ {
1052
+ "items": {
1053
+ "type": "string"
1054
+ },
1055
+ "type": "array"
1056
+ },
1057
+ {
1058
+ "items": {
1059
+ "$ref": "#/components/schemas/WithHref_Unbrand_XoVm__"
1060
+ },
1061
+ "type": "array"
1062
+ },
1063
+ {
1064
+ "items": {
1065
+ "$ref": "#/components/schemas/WithHref_Partial_Unbrand_XoVm___"
1066
+ },
1067
+ "type": "array"
1068
+ }
1069
+ ]
1070
+ },
1071
+ "examples": {
1072
+ "Example 1": {
1073
+ "value": [
1074
+ "/rest/v0/vms/f07ab729-c0e8-721c-45ec-f11276377030",
1075
+ "/rest/v0/vms/d5d1c4a3-4c5e-ca7b-6be8-33c824f87571"
1076
+ ]
1077
+ },
1078
+ "Example 2": {
1079
+ "value": [
1080
+ {
1081
+ "name_label": "foo",
1082
+ "power_state": "Running",
1083
+ "uuid": "f07ab729-c0e8-721c-45ec-f11276377030",
1084
+ "href": "/rest/v0/vms/f07ab729-c0e8-721c-45ec-f11276377030"
1085
+ },
1086
+ {
1087
+ "name_label": "foo_bar",
1088
+ "power_state": "Halted",
1089
+ "uuid": "d5d1c4a3-4c5e-ca7b-6be8-33c824f87571",
1090
+ "href": "/rest/v0/vms/d5d1c4a3-4c5e-ca7b-6be8-33c824f87571"
1091
+ }
1092
+ ]
1093
+ }
1094
+ }
1095
+ }
1096
+ }
1097
+ },
1098
+ "401": {
1099
+ "description": ""
1100
+ }
1101
+ },
1102
+ "security": [
1103
+ {
1104
+ "*": []
1105
+ }
1106
+ ],
1107
+ "parameters": [
1108
+ {
1109
+ "in": "query",
1110
+ "name": "fields",
1111
+ "required": false,
1112
+ "schema": {
1113
+ "type": "string"
1114
+ },
1115
+ "example": "name_label,power_state,uuid"
1116
+ },
1117
+ {
1118
+ "in": "query",
1119
+ "name": "filter",
1120
+ "required": false,
1121
+ "schema": {
1122
+ "type": "string"
1123
+ },
1124
+ "example": "power_state:Running"
1125
+ },
1126
+ {
1127
+ "in": "query",
1128
+ "name": "limit",
1129
+ "required": false,
1130
+ "schema": {
1131
+ "format": "double",
1132
+ "type": "number"
1133
+ },
1134
+ "example": 42
1135
+ }
1136
+ ]
1137
+ }
1138
+ },
1139
+ "/vms/{id}": {
1140
+ "get": {
1141
+ "operationId": "GetVm",
1142
+ "responses": {
1143
+ "200": {
1144
+ "description": "Ok",
1145
+ "content": {
1146
+ "application/json": {
1147
+ "schema": {
1148
+ "$ref": "#/components/schemas/Unbrand_XoVm_"
1149
+ },
1150
+ "examples": {
1151
+ "Example 1": {
1152
+ "value": {
1153
+ "type": "VM",
1154
+ "addresses": {},
1155
+ "auto_poweron": false,
1156
+ "bios_strings": {
1157
+ "bios-vendor": "Xen",
1158
+ "bios-version": "",
1159
+ "system-manufacturer": "Xen",
1160
+ "system-product-name": "HVM domU",
1161
+ "system-version": "",
1162
+ "system-serial-number": "",
1163
+ "hp-rombios": "",
1164
+ "oem-1": "Xen",
1165
+ "oem-2": "MS_VM_CERT/SHA1/bdbeb6e0a816d43fa6d3fe8aaef04c2bad9d3e3d"
1166
+ },
1167
+ "blockedOperations": {},
1168
+ "boot": {
1169
+ "firmware": "bios",
1170
+ "order": "cd"
1171
+ },
1172
+ "CPUs": {
1173
+ "max": 2,
1174
+ "number": 2
1175
+ },
1176
+ "creation": {
1177
+ "date": "2024-12-18T15:08:43.142Z",
1178
+ "template": "bfa83003-ac1a-dde9-6a44-6cca5fd3e735",
1179
+ "user": "d558dd75-c928-45f6-b8e3-4375bdda59f8"
1180
+ },
1181
+ "current_operations": {},
1182
+ "expNestedHvm": false,
1183
+ "viridian": false,
1184
+ "high_availability": "",
1185
+ "isFirmwareSupported": true,
1186
+ "memory": {
1187
+ "dynamic": [
1188
+ 4294967296,
1189
+ 4294967296
1190
+ ],
1191
+ "static": [
1192
+ 2147483648,
1193
+ 4294967296
1194
+ ],
1195
+ "size": 4294967296
1196
+ },
1197
+ "installTime": 1734534522,
1198
+ "name_description": "Debian 12 Cloud-Init Ready Hub Template",
1199
+ "name_label": "MRA XOA",
1200
+ "needsVtpm": false,
1201
+ "other": {
1202
+ "xo:f07ab729": "{\"creation\":{\"date\":\"2024-12-18T15:08:43.142Z\",\"template\":\"bfa83003-ac1a-dde9-6a44-6cca5fd3e735\",\"user\":\"d558dd75-c928-45f6-b8e3-4375bdda59f8\"}}",
1203
+ "xo:resource:namespace": "Debian12",
1204
+ "xo:resource:xva:version": "1.0.0",
1205
+ "xo:resource:xva:id": "e2fb63ba-1a5d-7527-bfca-14fef610bf6f",
1206
+ "xo:resource:installedTemplate:uuid": "bfa83003-ac1a-dde9-6a44-6cca5fd3e735",
1207
+ "import_task": "OpaqueRef:7c274dba-70ef-1f28-ab31-9c7ef5b26c51",
1208
+ "mac_seed": "ebcb83b9-b96d-6341-931c-9d5105656bf2",
1209
+ "vgpu_pci": "",
1210
+ "base_template_name": "Debian Jessie 8.0",
1211
+ "install-methods": "cdrom,nfs,http,ftp",
1212
+ "linux_template": "true"
1213
+ },
1214
+ "os_version": null,
1215
+ "power_state": "Halted",
1216
+ "hasVendorDevice": false,
1217
+ "snapshots": [],
1218
+ "startDelay": 0,
1219
+ "startTime": null,
1220
+ "secureBoot": false,
1221
+ "tags": [],
1222
+ "VIFs": [
1223
+ "803382fb-9d69-fbf7-8fef-2b3a8adfce5a"
1224
+ ],
1225
+ "VTPMs": [],
1226
+ "virtualizationMode": "hvm",
1227
+ "$container": "b7569d99-30f8-178a-7d94-801de3e29b5b",
1228
+ "$VBDs": [
1229
+ "43ecda28-e716-a60e-5322-ee6597d07aec",
1230
+ "a30d24aa-188c-dc6d-6ee3-5bf1e504a3e9"
1231
+ ],
1232
+ "VGPUs": [],
1233
+ "$VGPUs": [],
1234
+ "xenStoreData": {
1235
+ "vm-data/mmio-hole-size": "268435456",
1236
+ "vm-data": ""
1237
+ },
1238
+ "vga": "cirrus",
1239
+ "videoram": 4,
1240
+ "id": "f07ab729-c0e8-721c-45ec-f11276377030",
1241
+ "uuid": "f07ab729-c0e8-721c-45ec-f11276377030",
1242
+ "$pool": "b7569d99-30f8-178a-7d94-801de3e29b5b",
1243
+ "$poolId": "b7569d99-30f8-178a-7d94-801de3e29b5b",
1244
+ "_xapiRef": "OpaqueRef:ffdf8863-5331-9394-5c1b-d1db7de20a76"
1245
+ }
1246
+ }
1247
+ }
1248
+ }
1249
+ }
1250
+ },
1251
+ "401": {
1252
+ "description": ""
1253
+ },
1254
+ "404": {
1255
+ "description": ""
1256
+ }
1257
+ },
1258
+ "security": [
1259
+ {
1260
+ "*": []
1261
+ }
1262
+ ],
1263
+ "parameters": [
1264
+ {
1265
+ "in": "path",
1266
+ "name": "id",
1267
+ "required": true,
1268
+ "schema": {
1269
+ "type": "string"
1270
+ },
1271
+ "example": "f07ab729-c0e8-721c-45ec-f11276377030"
1272
+ }
1273
+ ]
1274
+ }
1275
+ }
1276
+ },
1277
+ "servers": [
1278
+ {
1279
+ "url": "/rest/v0"
1280
+ }
1281
+ ]
1282
+ }