@xen-orchestra/rest-api 0.12.0 → 0.13.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.
@@ -1465,6 +1465,135 @@
1465
1465
  "days"
1466
1466
  ]
1467
1467
  },
1468
+ "Partial_Unbrand_XoAlarm__": {
1469
+ "properties": {
1470
+ "$pool": {
1471
+ "type": "string"
1472
+ },
1473
+ "$poolId": {
1474
+ "type": "string",
1475
+ "deprecated": true
1476
+ },
1477
+ "_xapiRef": {
1478
+ "type": "string"
1479
+ },
1480
+ "uuid": {
1481
+ "type": "string"
1482
+ },
1483
+ "id": {
1484
+ "type": "string"
1485
+ },
1486
+ "type": {
1487
+ "type": "string",
1488
+ "enum": [
1489
+ "message"
1490
+ ]
1491
+ },
1492
+ "name": {
1493
+ "type": "string"
1494
+ },
1495
+ "time": {
1496
+ "type": "number",
1497
+ "format": "double"
1498
+ },
1499
+ "body": {
1500
+ "properties": {
1501
+ "name": {
1502
+ "type": "string"
1503
+ },
1504
+ "value": {
1505
+ "type": "string"
1506
+ }
1507
+ },
1508
+ "required": [
1509
+ "name"
1510
+ ],
1511
+ "type": "object"
1512
+ },
1513
+ "object": {
1514
+ "properties": {
1515
+ "href": {
1516
+ "type": "string"
1517
+ },
1518
+ "uuid": {
1519
+ "type": "string"
1520
+ },
1521
+ "type": {
1522
+ "type": "string",
1523
+ "enum": [
1524
+ "pool",
1525
+ "VBD",
1526
+ "host",
1527
+ "VIF",
1528
+ "VTPM",
1529
+ "VM",
1530
+ "VM-snapshot",
1531
+ "SR",
1532
+ "message",
1533
+ "vgpu",
1534
+ "gpuGroup",
1535
+ "network",
1536
+ "PCI",
1537
+ "PGPU",
1538
+ "PIF",
1539
+ "VDI",
1540
+ "VDI-snapshot",
1541
+ "VDI-unmanaged",
1542
+ "vgpuType",
1543
+ "VM-controller",
1544
+ "VM-template",
1545
+ "SM",
1546
+ "unknown"
1547
+ ]
1548
+ }
1549
+ },
1550
+ "required": [
1551
+ "uuid",
1552
+ "type"
1553
+ ],
1554
+ "type": "object"
1555
+ }
1556
+ },
1557
+ "type": "object",
1558
+ "description": "Make all properties in T optional"
1559
+ },
1560
+ "WithHref_Partial_Unbrand_XoAlarm___": {
1561
+ "allOf": [
1562
+ {
1563
+ "$ref": "#/components/schemas/Partial_Unbrand_XoAlarm__"
1564
+ },
1565
+ {
1566
+ "properties": {
1567
+ "href": {
1568
+ "type": "string"
1569
+ }
1570
+ },
1571
+ "required": [
1572
+ "href"
1573
+ ],
1574
+ "type": "object"
1575
+ }
1576
+ ]
1577
+ },
1578
+ "SendObjects_Partial_Unbrand_XoAlarm___": {
1579
+ "anyOf": [
1580
+ {
1581
+ "items": {
1582
+ "type": "string"
1583
+ },
1584
+ "type": "array"
1585
+ },
1586
+ {
1587
+ "items": {
1588
+ "$ref": "#/components/schemas/WithHref_Partial_Unbrand_XoAlarm___"
1589
+ },
1590
+ "type": "array"
1591
+ },
1592
+ {
1593
+ "$ref": "#/components/schemas/NdjsonStream"
1594
+ }
1595
+ ]
1596
+ },
1468
1597
  "Partial_Unbrand_XoVmTemplate__": {
1469
1598
  "properties": {
1470
1599
  "$pool": {
@@ -2329,7 +2458,7 @@
2329
2458
  ],
2330
2459
  "type": "object"
2331
2460
  },
2332
- "Partial_Unbrand_XoAlarm__": {
2461
+ "Partial_Unbrand_XoVmSnapshot__": {
2333
2462
  "properties": {
2334
2463
  "$pool": {
2335
2464
  "type": "string"
@@ -2344,185 +2473,56 @@
2344
2473
  "uuid": {
2345
2474
  "type": "string"
2346
2475
  },
2347
- "id": {
2348
- "type": "string"
2476
+ "$VBDs": {
2477
+ "items": {
2478
+ "type": "string"
2479
+ },
2480
+ "type": "array"
2349
2481
  },
2350
- "type": {
2351
- "type": "string",
2352
- "enum": [
2353
- "message"
2354
- ]
2482
+ "$VGPUs": {
2483
+ "items": {
2484
+ "type": "string"
2485
+ },
2486
+ "type": "array"
2355
2487
  },
2356
- "name": {
2488
+ "$container": {
2357
2489
  "type": "string"
2358
2490
  },
2359
- "time": {
2360
- "type": "number",
2361
- "format": "double"
2362
- },
2363
- "body": {
2491
+ "CPUs": {
2364
2492
  "properties": {
2365
- "name": {
2366
- "type": "string"
2493
+ "number": {
2494
+ "type": "number",
2495
+ "format": "double"
2367
2496
  },
2368
- "value": {
2369
- "type": "string"
2497
+ "max": {
2498
+ "type": "number",
2499
+ "format": "double"
2370
2500
  }
2371
2501
  },
2372
2502
  "required": [
2373
- "name"
2503
+ "number",
2504
+ "max"
2374
2505
  ],
2375
2506
  "type": "object"
2376
2507
  },
2377
- "object": {
2378
- "properties": {
2379
- "href": {
2380
- "type": "string"
2381
- },
2382
- "uuid": {
2383
- "type": "string"
2384
- },
2385
- "type": {
2386
- "type": "string",
2387
- "enum": [
2388
- "pool",
2389
- "VBD",
2390
- "host",
2391
- "VIF",
2392
- "VTPM",
2393
- "VM",
2394
- "VM-snapshot",
2395
- "SR",
2396
- "VM-template",
2397
- "message",
2398
- "vgpu",
2399
- "gpuGroup",
2400
- "network",
2401
- "PCI",
2402
- "PGPU",
2403
- "PIF",
2404
- "VDI",
2405
- "VDI-snapshot",
2406
- "VDI-unmanaged",
2407
- "vgpuType",
2408
- "VM-controller",
2409
- "SM",
2410
- "unknown"
2411
- ]
2412
- }
2413
- },
2414
- "required": [
2415
- "uuid",
2416
- "type"
2417
- ],
2418
- "type": "object"
2419
- }
2420
- },
2421
- "type": "object",
2422
- "description": "Make all properties in T optional"
2423
- },
2424
- "WithHref_Partial_Unbrand_XoAlarm___": {
2425
- "allOf": [
2426
- {
2427
- "$ref": "#/components/schemas/Partial_Unbrand_XoAlarm__"
2508
+ "PV_args": {
2509
+ "type": "string"
2428
2510
  },
2429
- {
2430
- "properties": {
2431
- "href": {
2432
- "type": "string"
2433
- }
2511
+ "VGPUs": {
2512
+ "items": {
2513
+ "type": "string"
2434
2514
  },
2435
- "required": [
2436
- "href"
2437
- ],
2438
- "type": "object"
2439
- }
2440
- ]
2441
- },
2442
- "SendObjects_Partial_Unbrand_XoAlarm___": {
2443
- "anyOf": [
2444
- {
2515
+ "type": "array"
2516
+ },
2517
+ "VIFs": {
2445
2518
  "items": {
2446
2519
  "type": "string"
2447
2520
  },
2448
2521
  "type": "array"
2449
2522
  },
2450
- {
2523
+ "VTPMs": {
2451
2524
  "items": {
2452
- "$ref": "#/components/schemas/WithHref_Partial_Unbrand_XoAlarm___"
2453
- },
2454
- "type": "array"
2455
- },
2456
- {
2457
- "$ref": "#/components/schemas/NdjsonStream"
2458
- }
2459
- ]
2460
- },
2461
- "Partial_Unbrand_XoVmSnapshot__": {
2462
- "properties": {
2463
- "$pool": {
2464
- "type": "string"
2465
- },
2466
- "$poolId": {
2467
- "type": "string",
2468
- "deprecated": true
2469
- },
2470
- "_xapiRef": {
2471
- "type": "string"
2472
- },
2473
- "uuid": {
2474
- "type": "string"
2475
- },
2476
- "$VBDs": {
2477
- "items": {
2478
- "type": "string"
2479
- },
2480
- "type": "array"
2481
- },
2482
- "$VGPUs": {
2483
- "items": {
2484
- "type": "string"
2485
- },
2486
- "type": "array"
2487
- },
2488
- "$container": {
2489
- "type": "string"
2490
- },
2491
- "CPUs": {
2492
- "properties": {
2493
- "number": {
2494
- "type": "number",
2495
- "format": "double"
2496
- },
2497
- "max": {
2498
- "type": "number",
2499
- "format": "double"
2500
- }
2501
- },
2502
- "required": [
2503
- "number",
2504
- "max"
2505
- ],
2506
- "type": "object"
2507
- },
2508
- "PV_args": {
2509
- "type": "string"
2510
- },
2511
- "VGPUs": {
2512
- "items": {
2513
- "type": "string"
2514
- },
2515
- "type": "array"
2516
- },
2517
- "VIFs": {
2518
- "items": {
2519
- "type": "string"
2520
- },
2521
- "type": "array"
2522
- },
2523
- "VTPMs": {
2524
- "items": {
2525
- "type": "string"
2525
+ "type": "string"
2526
2526
  },
2527
2527
  "type": "array"
2528
2528
  },
@@ -4952,6 +4952,24 @@
4952
4952
  ],
4953
4953
  "type": "object"
4954
4954
  },
4955
+ "UpdateUserRequestBody": {
4956
+ "properties": {
4957
+ "name": {
4958
+ "type": "string"
4959
+ },
4960
+ "password": {
4961
+ "type": "string"
4962
+ },
4963
+ "permission": {
4964
+ "type": "string"
4965
+ },
4966
+ "preferences": {
4967
+ "$ref": "#/components/schemas/Record_string.string_"
4968
+ }
4969
+ },
4970
+ "type": "object",
4971
+ "additionalProperties": false
4972
+ },
4955
4973
  "Record_string.STORAGE_OPERATIONS_": {
4956
4974
  "properties": {},
4957
4975
  "type": "object",
@@ -8624,6 +8642,15 @@
8624
8642
  ],
8625
8643
  "type": "object"
8626
8644
  },
8645
+ "UpdateGroupRequestBody": {
8646
+ "properties": {
8647
+ "name": {
8648
+ "type": "string"
8649
+ }
8650
+ },
8651
+ "type": "object",
8652
+ "additionalProperties": false
8653
+ },
8627
8654
  "Partial_Unbrand_XoBackupRepository__": {
8628
8655
  "properties": {
8629
8656
  "benchmarks": {
@@ -8834,7 +8861,6 @@
8834
8861
  "VM",
8835
8862
  "VM-snapshot",
8836
8863
  "SR",
8837
- "VM-template",
8838
8864
  "message",
8839
8865
  "vgpu",
8840
8866
  "gpuGroup",
@@ -8847,6 +8873,7 @@
8847
8873
  "VDI-unmanaged",
8848
8874
  "vgpuType",
8849
8875
  "VM-controller",
8876
+ "VM-template",
8850
8877
  "SM",
8851
8878
  "unknown"
8852
8879
  ]
@@ -8964,7 +8991,6 @@
8964
8991
  "VM",
8965
8992
  "VM-snapshot",
8966
8993
  "SR",
8967
- "VM-template",
8968
8994
  "message",
8969
8995
  "vgpu",
8970
8996
  "gpuGroup",
@@ -8977,6 +9003,7 @@
8977
9003
  "VDI-unmanaged",
8978
9004
  "vgpuType",
8979
9005
  "VM-controller",
9006
+ "VM-template",
8980
9007
  "SM",
8981
9008
  "unknown"
8982
9009
  ]
@@ -9017,7 +9044,7 @@
9017
9044
  },
9018
9045
  "info": {
9019
9046
  "title": "@xen-orchestra/rest-api",
9020
- "version": "0.12.0",
9047
+ "version": "0.13.1",
9021
9048
  "description": "REST API to manage your XOA",
9022
9049
  "license": {
9023
9050
  "name": "AGPL-3.0-or-later"
@@ -11458,6 +11485,101 @@
11458
11485
  }
11459
11486
  }
11460
11487
  },
11488
+ "/vms/{id}/alarms": {
11489
+ "get": {
11490
+ "operationId": "GetVmAlarms",
11491
+ "responses": {
11492
+ "200": {
11493
+ "description": "Ok",
11494
+ "content": {
11495
+ "application/json": {
11496
+ "schema": {
11497
+ "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoAlarm___"
11498
+ },
11499
+ "examples": {
11500
+ "Example 1": {
11501
+ "value": [
11502
+ {
11503
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604b",
11504
+ "time": 1747053794,
11505
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604b"
11506
+ },
11507
+ {
11508
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604c",
11509
+ "time": 1747053795,
11510
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604c"
11511
+ }
11512
+ ]
11513
+ }
11514
+ }
11515
+ }
11516
+ }
11517
+ },
11518
+ "401": {
11519
+ "description": "Authentication required"
11520
+ },
11521
+ "404": {
11522
+ "description": "Resource not found"
11523
+ }
11524
+ },
11525
+ "tags": [
11526
+ "alarms",
11527
+ "vms"
11528
+ ],
11529
+ "security": [
11530
+ {
11531
+ "*": []
11532
+ }
11533
+ ],
11534
+ "parameters": [
11535
+ {
11536
+ "in": "path",
11537
+ "name": "id",
11538
+ "required": true,
11539
+ "schema": {
11540
+ "type": "string"
11541
+ },
11542
+ "example": "f07ab729-c0e8-721c-45ec-f11276377030"
11543
+ },
11544
+ {
11545
+ "in": "query",
11546
+ "name": "fields",
11547
+ "required": false,
11548
+ "schema": {
11549
+ "type": "string"
11550
+ },
11551
+ "example": "id,time"
11552
+ },
11553
+ {
11554
+ "in": "query",
11555
+ "name": "ndjson",
11556
+ "required": false,
11557
+ "schema": {
11558
+ "type": "boolean"
11559
+ }
11560
+ },
11561
+ {
11562
+ "in": "query",
11563
+ "name": "filter",
11564
+ "required": false,
11565
+ "schema": {
11566
+ "type": "string"
11567
+ },
11568
+ "example": "time:>1747053793"
11569
+ },
11570
+ {
11571
+ "in": "query",
11572
+ "name": "limit",
11573
+ "required": false,
11574
+ "schema": {
11575
+ "format": "double",
11576
+ "type": "number"
11577
+ },
11578
+ "example": 42
11579
+ }
11580
+ ]
11581
+ }
11582
+ },
11461
11583
  "/vm-templates": {
11462
11584
  "get": {
11463
11585
  "operationId": "GetVmTemplates",
@@ -12093,35 +12215,29 @@
12093
12215
  ]
12094
12216
  }
12095
12217
  },
12096
- "/vm-controllers": {
12218
+ "/vm-snapshots/{id}/alarms": {
12097
12219
  "get": {
12098
- "operationId": "GetVmControllers",
12220
+ "operationId": "GetVmSnapshotAlarms",
12099
12221
  "responses": {
12100
12222
  "200": {
12101
12223
  "description": "Ok",
12102
12224
  "content": {
12103
12225
  "application/json": {
12104
12226
  "schema": {
12105
- "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoVmController___"
12227
+ "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoAlarm___"
12106
12228
  },
12107
12229
  "examples": {
12108
12230
  "Example 1": {
12109
- "value": [
12110
- "/rest/v0/vm-controller/9b4775bd-9493-490a-9afa-f786a44caa4f",
12111
- "/rest/v0/vm-controller/e3fc847c-159a-48dc-bee4-cf2da216a795"
12112
- ]
12113
- },
12114
- "Example 2": {
12115
12231
  "value": [
12116
12232
  {
12117
- "type": "VM-controller",
12118
- "uuid": "9b4775bd-9493-490a-9afa-f786a44caa4f",
12119
- "href": "/rest/v0/vm-controller/9b4775bd-9493-490a-9afa-f786a44caa4f"
12233
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604b",
12234
+ "time": 1747053794,
12235
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604b"
12120
12236
  },
12121
12237
  {
12122
- "type": "VM-controller",
12123
- "uuid": "e3fc847c-159a-48dc-bee4-cf2da216a795",
12124
- "href": "/rest/v0/vm-controller/e3fc847c-159a-48dc-bee4-cf2da216a795"
12238
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604c",
12239
+ "time": 1747053795,
12240
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604c"
12125
12241
  }
12126
12242
  ]
12127
12243
  }
@@ -12131,9 +12247,13 @@
12131
12247
  },
12132
12248
  "401": {
12133
12249
  "description": "Authentication required"
12250
+ },
12251
+ "404": {
12252
+ "description": "Resource not found"
12134
12253
  }
12135
12254
  },
12136
12255
  "tags": [
12256
+ "alarms",
12137
12257
  "vms"
12138
12258
  ],
12139
12259
  "security": [
@@ -12142,6 +12262,15 @@
12142
12262
  }
12143
12263
  ],
12144
12264
  "parameters": [
12265
+ {
12266
+ "in": "path",
12267
+ "name": "id",
12268
+ "required": true,
12269
+ "schema": {
12270
+ "type": "string"
12271
+ },
12272
+ "example": "d68fca2c-41e6-be87-d790-105c1642a090"
12273
+ },
12145
12274
  {
12146
12275
  "in": "query",
12147
12276
  "name": "fields",
@@ -12149,7 +12278,7 @@
12149
12278
  "schema": {
12150
12279
  "type": "string"
12151
12280
  },
12152
- "example": "type,uuid"
12281
+ "example": "id,time"
12153
12282
  },
12154
12283
  {
12155
12284
  "in": "query",
@@ -12166,7 +12295,7 @@
12166
12295
  "schema": {
12167
12296
  "type": "string"
12168
12297
  },
12169
- "example": "power_state:Running"
12298
+ "example": "time:>1747053793"
12170
12299
  },
12171
12300
  {
12172
12301
  "in": "query",
@@ -12181,34 +12310,122 @@
12181
12310
  ]
12182
12311
  }
12183
12312
  },
12184
- "/vm-controllers/{id}": {
12313
+ "/vm-controllers": {
12185
12314
  "get": {
12186
- "operationId": "GetVmController",
12315
+ "operationId": "GetVmControllers",
12187
12316
  "responses": {
12188
12317
  "200": {
12189
12318
  "description": "Ok",
12190
12319
  "content": {
12191
12320
  "application/json": {
12192
12321
  "schema": {
12193
- "$ref": "#/components/schemas/Unbrand_XoVmController_"
12322
+ "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoVmController___"
12194
12323
  },
12195
12324
  "examples": {
12196
12325
  "Example 1": {
12197
- "value": {
12198
- "type": "VM-controller",
12199
- "addresses": {},
12200
- "affinityHost": "b61a5c92-700e-4966-a13b-00633f03eea8",
12201
- "auto_poweron": false,
12202
- "bios_strings": {},
12203
- "blockedOperations": {},
12204
- "boot": {},
12205
- "CPUs": {
12206
- "max": 8,
12207
- "number": 8
12326
+ "value": [
12327
+ "/rest/v0/vm-controller/9b4775bd-9493-490a-9afa-f786a44caa4f",
12328
+ "/rest/v0/vm-controller/e3fc847c-159a-48dc-bee4-cf2da216a795"
12329
+ ]
12330
+ },
12331
+ "Example 2": {
12332
+ "value": [
12333
+ {
12334
+ "type": "VM-controller",
12335
+ "uuid": "9b4775bd-9493-490a-9afa-f786a44caa4f",
12336
+ "href": "/rest/v0/vm-controller/9b4775bd-9493-490a-9afa-f786a44caa4f"
12208
12337
  },
12209
- "current_operations": {},
12210
- "expNestedHvm": false,
12211
- "viridian": false,
12338
+ {
12339
+ "type": "VM-controller",
12340
+ "uuid": "e3fc847c-159a-48dc-bee4-cf2da216a795",
12341
+ "href": "/rest/v0/vm-controller/e3fc847c-159a-48dc-bee4-cf2da216a795"
12342
+ }
12343
+ ]
12344
+ }
12345
+ }
12346
+ }
12347
+ }
12348
+ },
12349
+ "401": {
12350
+ "description": "Authentication required"
12351
+ }
12352
+ },
12353
+ "tags": [
12354
+ "vms"
12355
+ ],
12356
+ "security": [
12357
+ {
12358
+ "*": []
12359
+ }
12360
+ ],
12361
+ "parameters": [
12362
+ {
12363
+ "in": "query",
12364
+ "name": "fields",
12365
+ "required": false,
12366
+ "schema": {
12367
+ "type": "string"
12368
+ },
12369
+ "example": "type,uuid"
12370
+ },
12371
+ {
12372
+ "in": "query",
12373
+ "name": "ndjson",
12374
+ "required": false,
12375
+ "schema": {
12376
+ "type": "boolean"
12377
+ }
12378
+ },
12379
+ {
12380
+ "in": "query",
12381
+ "name": "filter",
12382
+ "required": false,
12383
+ "schema": {
12384
+ "type": "string"
12385
+ },
12386
+ "example": "power_state:Running"
12387
+ },
12388
+ {
12389
+ "in": "query",
12390
+ "name": "limit",
12391
+ "required": false,
12392
+ "schema": {
12393
+ "format": "double",
12394
+ "type": "number"
12395
+ },
12396
+ "example": 42
12397
+ }
12398
+ ]
12399
+ }
12400
+ },
12401
+ "/vm-controllers/{id}": {
12402
+ "get": {
12403
+ "operationId": "GetVmController",
12404
+ "responses": {
12405
+ "200": {
12406
+ "description": "Ok",
12407
+ "content": {
12408
+ "application/json": {
12409
+ "schema": {
12410
+ "$ref": "#/components/schemas/Unbrand_XoVmController_"
12411
+ },
12412
+ "examples": {
12413
+ "Example 1": {
12414
+ "value": {
12415
+ "type": "VM-controller",
12416
+ "addresses": {},
12417
+ "affinityHost": "b61a5c92-700e-4966-a13b-00633f03eea8",
12418
+ "auto_poweron": false,
12419
+ "bios_strings": {},
12420
+ "blockedOperations": {},
12421
+ "boot": {},
12422
+ "CPUs": {
12423
+ "max": 8,
12424
+ "number": 8
12425
+ },
12426
+ "current_operations": {},
12427
+ "expNestedHvm": false,
12428
+ "viridian": false,
12212
12429
  "high_availability": "",
12213
12430
  "isFirmwareSupported": true,
12214
12431
  "memory": {
@@ -12288,6 +12505,101 @@
12288
12505
  ]
12289
12506
  }
12290
12507
  },
12508
+ "/vm-controllers/{id}/alarms": {
12509
+ "get": {
12510
+ "operationId": "GetVmControllerAlarms",
12511
+ "responses": {
12512
+ "200": {
12513
+ "description": "Ok",
12514
+ "content": {
12515
+ "application/json": {
12516
+ "schema": {
12517
+ "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoAlarm___"
12518
+ },
12519
+ "examples": {
12520
+ "Example 1": {
12521
+ "value": [
12522
+ {
12523
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604b",
12524
+ "time": 1747053794,
12525
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604b"
12526
+ },
12527
+ {
12528
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604c",
12529
+ "time": 1747053795,
12530
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604c"
12531
+ }
12532
+ ]
12533
+ }
12534
+ }
12535
+ }
12536
+ }
12537
+ },
12538
+ "401": {
12539
+ "description": "Authentication required"
12540
+ },
12541
+ "404": {
12542
+ "description": "Resource not found"
12543
+ }
12544
+ },
12545
+ "tags": [
12546
+ "alarms",
12547
+ "vms"
12548
+ ],
12549
+ "security": [
12550
+ {
12551
+ "*": []
12552
+ }
12553
+ ],
12554
+ "parameters": [
12555
+ {
12556
+ "in": "path",
12557
+ "name": "id",
12558
+ "required": true,
12559
+ "schema": {
12560
+ "type": "string"
12561
+ },
12562
+ "example": "9b4775bd-9493-490a-9afa-f786a44caa4f"
12563
+ },
12564
+ {
12565
+ "in": "query",
12566
+ "name": "fields",
12567
+ "required": false,
12568
+ "schema": {
12569
+ "type": "string"
12570
+ },
12571
+ "example": "id,time"
12572
+ },
12573
+ {
12574
+ "in": "query",
12575
+ "name": "ndjson",
12576
+ "required": false,
12577
+ "schema": {
12578
+ "type": "boolean"
12579
+ }
12580
+ },
12581
+ {
12582
+ "in": "query",
12583
+ "name": "filter",
12584
+ "required": false,
12585
+ "schema": {
12586
+ "type": "string"
12587
+ },
12588
+ "example": "time:>1747053793"
12589
+ },
12590
+ {
12591
+ "in": "query",
12592
+ "name": "limit",
12593
+ "required": false,
12594
+ "schema": {
12595
+ "format": "double",
12596
+ "type": "number"
12597
+ },
12598
+ "example": 42
12599
+ }
12600
+ ]
12601
+ }
12602
+ },
12291
12603
  "/vifs": {
12292
12604
  "get": {
12293
12605
  "operationId": "GetVifs",
@@ -12443,6 +12755,101 @@
12443
12755
  ]
12444
12756
  }
12445
12757
  },
12758
+ "/vifs/{id}/alarms": {
12759
+ "get": {
12760
+ "operationId": "GetVifAlarms",
12761
+ "responses": {
12762
+ "200": {
12763
+ "description": "Ok",
12764
+ "content": {
12765
+ "application/json": {
12766
+ "schema": {
12767
+ "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoAlarm___"
12768
+ },
12769
+ "examples": {
12770
+ "Example 1": {
12771
+ "value": [
12772
+ {
12773
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604b",
12774
+ "time": 1747053794,
12775
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604b"
12776
+ },
12777
+ {
12778
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604c",
12779
+ "time": 1747053795,
12780
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604c"
12781
+ }
12782
+ ]
12783
+ }
12784
+ }
12785
+ }
12786
+ }
12787
+ },
12788
+ "401": {
12789
+ "description": "Authentication required"
12790
+ },
12791
+ "404": {
12792
+ "description": "Resource not found"
12793
+ }
12794
+ },
12795
+ "tags": [
12796
+ "alarms",
12797
+ "vifs"
12798
+ ],
12799
+ "security": [
12800
+ {
12801
+ "*": []
12802
+ }
12803
+ ],
12804
+ "parameters": [
12805
+ {
12806
+ "in": "path",
12807
+ "name": "id",
12808
+ "required": true,
12809
+ "schema": {
12810
+ "type": "string"
12811
+ },
12812
+ "example": "f028c5d4-578a-332c-394e-087aaca32dd3"
12813
+ },
12814
+ {
12815
+ "in": "query",
12816
+ "name": "fields",
12817
+ "required": false,
12818
+ "schema": {
12819
+ "type": "string"
12820
+ },
12821
+ "example": "id,time"
12822
+ },
12823
+ {
12824
+ "in": "query",
12825
+ "name": "ndjson",
12826
+ "required": false,
12827
+ "schema": {
12828
+ "type": "boolean"
12829
+ }
12830
+ },
12831
+ {
12832
+ "in": "query",
12833
+ "name": "filter",
12834
+ "required": false,
12835
+ "schema": {
12836
+ "type": "string"
12837
+ },
12838
+ "example": "time:>1747053793"
12839
+ },
12840
+ {
12841
+ "in": "query",
12842
+ "name": "limit",
12843
+ "required": false,
12844
+ "schema": {
12845
+ "format": "double",
12846
+ "type": "number"
12847
+ },
12848
+ "example": 42
12849
+ }
12850
+ ]
12851
+ }
12852
+ },
12446
12853
  "/vdis": {
12447
12854
  "get": {
12448
12855
  "operationId": "GetVdis",
@@ -13150,7 +13557,102 @@
13150
13557
  "schema": {
13151
13558
  "type": "string"
13152
13559
  },
13153
- "example": "f07ab729-c0e8-721c-45ec-f11276377030"
13560
+ "example": "f07ab729-c0e8-721c-45ec-f11276377030"
13561
+ }
13562
+ ]
13563
+ }
13564
+ },
13565
+ "/vbds/{id}/alarms": {
13566
+ "get": {
13567
+ "operationId": "GetVbdAlarms",
13568
+ "responses": {
13569
+ "200": {
13570
+ "description": "Ok",
13571
+ "content": {
13572
+ "application/json": {
13573
+ "schema": {
13574
+ "$ref": "#/components/schemas/SendObjects_Partial_Unbrand_XoAlarm___"
13575
+ },
13576
+ "examples": {
13577
+ "Example 1": {
13578
+ "value": [
13579
+ {
13580
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604b",
13581
+ "time": 1747053794,
13582
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604b"
13583
+ },
13584
+ {
13585
+ "id": "7e87b95e-8ebb-31c5-30ad-ff2eb079604c",
13586
+ "time": 1747053795,
13587
+ "href": "/rest/v0/alarms/7e87b95e-8ebb-31c5-30ad-ff2eb079604c"
13588
+ }
13589
+ ]
13590
+ }
13591
+ }
13592
+ }
13593
+ }
13594
+ },
13595
+ "401": {
13596
+ "description": "Authentication required"
13597
+ },
13598
+ "404": {
13599
+ "description": "Resource not found"
13600
+ }
13601
+ },
13602
+ "tags": [
13603
+ "alarms",
13604
+ "vbds"
13605
+ ],
13606
+ "security": [
13607
+ {
13608
+ "*": []
13609
+ }
13610
+ ],
13611
+ "parameters": [
13612
+ {
13613
+ "in": "path",
13614
+ "name": "id",
13615
+ "required": true,
13616
+ "schema": {
13617
+ "type": "string"
13618
+ },
13619
+ "example": "f07ab729-c0e8-721c-45ec-f11276377030"
13620
+ },
13621
+ {
13622
+ "in": "query",
13623
+ "name": "fields",
13624
+ "required": false,
13625
+ "schema": {
13626
+ "type": "string"
13627
+ },
13628
+ "example": "id,time"
13629
+ },
13630
+ {
13631
+ "in": "query",
13632
+ "name": "ndjson",
13633
+ "required": false,
13634
+ "schema": {
13635
+ "type": "boolean"
13636
+ }
13637
+ },
13638
+ {
13639
+ "in": "query",
13640
+ "name": "filter",
13641
+ "required": false,
13642
+ "schema": {
13643
+ "type": "string"
13644
+ },
13645
+ "example": "time:>1747053793"
13646
+ },
13647
+ {
13648
+ "in": "query",
13649
+ "name": "limit",
13650
+ "required": false,
13651
+ "schema": {
13652
+ "format": "double",
13653
+ "type": "number"
13654
+ },
13655
+ "example": 42
13154
13656
  }
13155
13657
  ]
13156
13658
  }
@@ -13376,6 +13878,61 @@
13376
13878
  }
13377
13879
  ]
13378
13880
  },
13881
+ "patch": {
13882
+ "operationId": "UpdateUser",
13883
+ "responses": {
13884
+ "204": {
13885
+ "description": "No content"
13886
+ },
13887
+ "401": {
13888
+ "description": "Authentication required"
13889
+ },
13890
+ "403": {
13891
+ "description": "Forbidden"
13892
+ },
13893
+ "404": {
13894
+ "description": "Resource not found"
13895
+ },
13896
+ "409": {
13897
+ "description": "Resource already exists"
13898
+ }
13899
+ },
13900
+ "tags": [
13901
+ "users"
13902
+ ],
13903
+ "security": [
13904
+ {
13905
+ "*": []
13906
+ }
13907
+ ],
13908
+ "parameters": [
13909
+ {
13910
+ "in": "path",
13911
+ "name": "id",
13912
+ "required": true,
13913
+ "schema": {
13914
+ "type": "string"
13915
+ },
13916
+ "example": "722d17b9-699b-49d2-8193-be1ac573d3de"
13917
+ }
13918
+ ],
13919
+ "requestBody": {
13920
+ "required": true,
13921
+ "content": {
13922
+ "application/json": {
13923
+ "schema": {
13924
+ "$ref": "#/components/schemas/UpdateUserRequestBody"
13925
+ },
13926
+ "example": {
13927
+ "name": "updated user name",
13928
+ "password": "newP4ssword",
13929
+ "permission": "admin",
13930
+ "preferences": {}
13931
+ }
13932
+ }
13933
+ }
13934
+ }
13935
+ },
13379
13936
  "delete": {
13380
13937
  "operationId": "DeleteUser",
13381
13938
  "responses": {
@@ -25292,6 +25849,75 @@
25292
25849
  "example": 42
25293
25850
  }
25294
25851
  ]
25852
+ },
25853
+ "post": {
25854
+ "operationId": "CreateGroup",
25855
+ "responses": {
25856
+ "201": {
25857
+ "description": "Resource created",
25858
+ "content": {
25859
+ "application/json": {
25860
+ "schema": {
25861
+ "properties": {
25862
+ "id": {
25863
+ "type": "string"
25864
+ }
25865
+ },
25866
+ "required": [
25867
+ "id"
25868
+ ],
25869
+ "type": "object"
25870
+ },
25871
+ "examples": {
25872
+ "Example 1": {
25873
+ "value": {
25874
+ "id": "67bfee1d-a021-4307-a53a-9fec2b2bd67d"
25875
+ }
25876
+ }
25877
+ }
25878
+ }
25879
+ }
25880
+ },
25881
+ "401": {
25882
+ "description": "Authentication required"
25883
+ },
25884
+ "409": {
25885
+ "description": "Resource already exists"
25886
+ },
25887
+ "422": {
25888
+ "description": "Invalid parameters"
25889
+ }
25890
+ },
25891
+ "tags": [
25892
+ "groups"
25893
+ ],
25894
+ "security": [
25895
+ {
25896
+ "*": []
25897
+ }
25898
+ ],
25899
+ "parameters": [],
25900
+ "requestBody": {
25901
+ "required": true,
25902
+ "content": {
25903
+ "application/json": {
25904
+ "schema": {
25905
+ "properties": {
25906
+ "name": {
25907
+ "type": "string"
25908
+ }
25909
+ },
25910
+ "required": [
25911
+ "name"
25912
+ ],
25913
+ "type": "object"
25914
+ },
25915
+ "example": {
25916
+ "name": "new group"
25917
+ }
25918
+ }
25919
+ }
25920
+ }
25295
25921
  }
25296
25922
  },
25297
25923
  "/groups/{id}": {
@@ -25346,6 +25972,58 @@
25346
25972
  }
25347
25973
  ]
25348
25974
  },
25975
+ "patch": {
25976
+ "operationId": "UpdateGroup",
25977
+ "responses": {
25978
+ "204": {
25979
+ "description": "No content"
25980
+ },
25981
+ "401": {
25982
+ "description": "Authentication required"
25983
+ },
25984
+ "403": {
25985
+ "description": "Forbidden"
25986
+ },
25987
+ "404": {
25988
+ "description": "Resource not found"
25989
+ },
25990
+ "409": {
25991
+ "description": "Resource already exists"
25992
+ }
25993
+ },
25994
+ "tags": [
25995
+ "groups"
25996
+ ],
25997
+ "security": [
25998
+ {
25999
+ "*": []
26000
+ }
26001
+ ],
26002
+ "parameters": [
26003
+ {
26004
+ "in": "path",
26005
+ "name": "id",
26006
+ "required": true,
26007
+ "schema": {
26008
+ "type": "string"
26009
+ },
26010
+ "example": "c98395a7-26d8-4e09-b055-d5f0f4a98312"
26011
+ }
26012
+ ],
26013
+ "requestBody": {
26014
+ "required": true,
26015
+ "content": {
26016
+ "application/json": {
26017
+ "schema": {
26018
+ "$ref": "#/components/schemas/UpdateGroupRequestBody"
26019
+ },
26020
+ "example": {
26021
+ "name": "new group name"
26022
+ }
26023
+ }
26024
+ }
26025
+ }
26026
+ },
25349
26027
  "delete": {
25350
26028
  "operationId": "DeleteGroup",
25351
26029
  "responses": {
@@ -25380,6 +26058,98 @@
25380
26058
  ]
25381
26059
  }
25382
26060
  },
26061
+ "/groups/{id}/users/{userId}": {
26062
+ "delete": {
26063
+ "operationId": "RemoveUserFromGroup",
26064
+ "responses": {
26065
+ "204": {
26066
+ "description": "No content"
26067
+ },
26068
+ "401": {
26069
+ "description": "Authentication required"
26070
+ },
26071
+ "403": {
26072
+ "description": "Forbidden"
26073
+ },
26074
+ "404": {
26075
+ "description": "Resource not found"
26076
+ }
26077
+ },
26078
+ "tags": [
26079
+ "groups"
26080
+ ],
26081
+ "security": [
26082
+ {
26083
+ "*": []
26084
+ }
26085
+ ],
26086
+ "parameters": [
26087
+ {
26088
+ "in": "path",
26089
+ "name": "id",
26090
+ "required": true,
26091
+ "schema": {
26092
+ "type": "string"
26093
+ },
26094
+ "example": "c98395a7-26d8-4e09-b055-d5f0f4a98312"
26095
+ },
26096
+ {
26097
+ "in": "path",
26098
+ "name": "userId",
26099
+ "required": true,
26100
+ "schema": {
26101
+ "type": "string"
26102
+ },
26103
+ "example": "722d17b9-699b-49d2-8193-be1ac573d3de"
26104
+ }
26105
+ ]
26106
+ },
26107
+ "put": {
26108
+ "operationId": "AddUserToGroup",
26109
+ "responses": {
26110
+ "204": {
26111
+ "description": "No content"
26112
+ },
26113
+ "401": {
26114
+ "description": "Authentication required"
26115
+ },
26116
+ "403": {
26117
+ "description": "Forbidden"
26118
+ },
26119
+ "404": {
26120
+ "description": "Resource not found"
26121
+ }
26122
+ },
26123
+ "tags": [
26124
+ "groups"
26125
+ ],
26126
+ "security": [
26127
+ {
26128
+ "*": []
26129
+ }
26130
+ ],
26131
+ "parameters": [
26132
+ {
26133
+ "in": "path",
26134
+ "name": "id",
26135
+ "required": true,
26136
+ "schema": {
26137
+ "type": "string"
26138
+ },
26139
+ "example": "6c81b5e1-afc1-43ea-8f8d-939ceb5f3f90"
26140
+ },
26141
+ {
26142
+ "in": "path",
26143
+ "name": "userId",
26144
+ "required": true,
26145
+ "schema": {
26146
+ "type": "string"
26147
+ },
26148
+ "example": "722d17b9-699b-49d2-8193-be1ac573d3de"
26149
+ }
26150
+ ]
26151
+ }
26152
+ },
25383
26153
  "/backup-repositories": {
25384
26154
  "get": {
25385
26155
  "operationId": "GetRepositories",