@openshift-migration-advisor/agent-sdk 0.12.0-d5edcd6935f2 → 0.12.0-e4c04f972747

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 (184) hide show
  1. package/.openapi-generator/FILES +22 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +25 -5
  4. package/dist/apis/DefaultApi.d.ts +369 -38
  5. package/dist/apis/DefaultApi.js +410 -43
  6. package/dist/esm/apis/DefaultApi.d.ts +369 -38
  7. package/dist/esm/apis/DefaultApi.js +410 -43
  8. package/dist/esm/models/AgentStatus.d.ts +1 -1
  9. package/dist/esm/models/AgentStatus.js +3 -3
  10. package/dist/esm/models/ApplicationListResponse.d.ts +33 -0
  11. package/dist/esm/models/ApplicationListResponse.js +44 -0
  12. package/dist/esm/models/ApplicationOverview.d.ts +51 -0
  13. package/dist/esm/models/ApplicationOverview.js +56 -0
  14. package/dist/esm/models/ApplicationVM.d.ts +38 -0
  15. package/dist/esm/models/ApplicationVM.js +47 -0
  16. package/dist/esm/models/ClusterFeatures.d.ts +54 -0
  17. package/dist/esm/models/ClusterFeatures.js +54 -0
  18. package/dist/esm/models/ClusterUtilization.d.ts +68 -0
  19. package/dist/esm/models/ClusterUtilization.js +67 -0
  20. package/dist/esm/models/CreateGroupRequest.d.ts +0 -6
  21. package/dist/esm/models/CreateGroupRequest.js +0 -2
  22. package/dist/esm/models/DeleteLabelGloballyResponse.d.ts +38 -0
  23. package/dist/esm/models/DeleteLabelGloballyResponse.js +47 -0
  24. package/dist/esm/models/Group.d.ts +0 -6
  25. package/dist/esm/models/Group.js +0 -2
  26. package/dist/esm/models/GroupResponse.d.ts +7 -0
  27. package/dist/esm/models/GroupResponse.js +3 -0
  28. package/dist/esm/models/Inventory.d.ts +7 -1
  29. package/dist/esm/models/Inventory.js +5 -3
  30. package/dist/esm/models/InventoryData.d.ts +14 -0
  31. package/dist/esm/models/InventoryData.js +6 -0
  32. package/dist/esm/models/RightsizingClusterListResponse.d.ts +1 -1
  33. package/dist/esm/models/RightsizingClusterListResponse.js +3 -3
  34. package/dist/esm/models/RightsizingClusterResponse.d.ts +39 -0
  35. package/dist/esm/models/RightsizingClusterResponse.js +48 -0
  36. package/dist/esm/models/RightsizingClusterUtilization.d.ts +12 -12
  37. package/dist/esm/models/RightsizingClusterUtilization.js +36 -36
  38. package/dist/esm/models/RightsizingCollectRequest.d.ts +6 -6
  39. package/dist/esm/models/RightsizingCollectRequest.js +12 -12
  40. package/dist/esm/models/RightsizingMetricStats.d.ts +1 -1
  41. package/dist/esm/models/RightsizingMetricStats.js +3 -3
  42. package/dist/esm/models/RightsizingReport.d.ts +6 -6
  43. package/dist/esm/models/RightsizingReport.js +18 -18
  44. package/dist/esm/models/RightsizingReportSummary.d.ts +6 -6
  45. package/dist/esm/models/RightsizingReportSummary.js +18 -18
  46. package/dist/esm/models/UpdateGroupRequest.d.ts +0 -6
  47. package/dist/esm/models/UpdateGroupRequest.js +0 -2
  48. package/dist/esm/models/UpdateLabelVMsRequest.d.ts +38 -0
  49. package/dist/esm/models/UpdateLabelVMsRequest.js +43 -0
  50. package/dist/esm/models/VMFilterOptionsResponse.d.ts +56 -0
  51. package/dist/esm/models/VMFilterOptionsResponse.js +59 -0
  52. package/dist/esm/models/VMLabelsResponse.d.ts +38 -0
  53. package/dist/esm/models/VMLabelsResponse.js +47 -0
  54. package/dist/esm/models/VMNIC.d.ts +12 -0
  55. package/dist/esm/models/VMNIC.js +4 -0
  56. package/dist/esm/models/VirtualMachine.d.ts +30 -6
  57. package/dist/esm/models/VirtualMachine.js +18 -10
  58. package/dist/esm/models/VirtualMachineDetail.d.ts +12 -0
  59. package/dist/esm/models/VirtualMachineDetail.js +4 -0
  60. package/dist/esm/models/VirtualMachineUpdateRequest.d.ts +38 -0
  61. package/dist/esm/models/VirtualMachineUpdateRequest.js +43 -0
  62. package/dist/esm/models/VmUtilizationDetails.d.ts +12 -12
  63. package/dist/esm/models/VmUtilizationDetails.js +36 -36
  64. package/dist/esm/models/index.d.ts +11 -0
  65. package/dist/esm/models/index.js +11 -0
  66. package/dist/models/AgentStatus.d.ts +1 -1
  67. package/dist/models/AgentStatus.js +3 -3
  68. package/dist/models/ApplicationListResponse.d.ts +33 -0
  69. package/dist/models/ApplicationListResponse.js +51 -0
  70. package/dist/models/ApplicationOverview.d.ts +51 -0
  71. package/dist/models/ApplicationOverview.js +63 -0
  72. package/dist/models/ApplicationVM.d.ts +38 -0
  73. package/dist/models/ApplicationVM.js +54 -0
  74. package/dist/models/ClusterFeatures.d.ts +54 -0
  75. package/dist/models/ClusterFeatures.js +62 -0
  76. package/dist/models/ClusterUtilization.d.ts +68 -0
  77. package/dist/models/ClusterUtilization.js +74 -0
  78. package/dist/models/CreateGroupRequest.d.ts +0 -6
  79. package/dist/models/CreateGroupRequest.js +0 -2
  80. package/dist/models/DeleteLabelGloballyResponse.d.ts +38 -0
  81. package/dist/models/DeleteLabelGloballyResponse.js +54 -0
  82. package/dist/models/Group.d.ts +0 -6
  83. package/dist/models/Group.js +0 -2
  84. package/dist/models/GroupResponse.d.ts +7 -0
  85. package/dist/models/GroupResponse.js +3 -0
  86. package/dist/models/Inventory.d.ts +7 -1
  87. package/dist/models/Inventory.js +5 -3
  88. package/dist/models/InventoryData.d.ts +14 -0
  89. package/dist/models/InventoryData.js +6 -0
  90. package/dist/models/RightsizingClusterListResponse.d.ts +1 -1
  91. package/dist/models/RightsizingClusterListResponse.js +3 -3
  92. package/dist/models/RightsizingClusterResponse.d.ts +39 -0
  93. package/dist/models/RightsizingClusterResponse.js +55 -0
  94. package/dist/models/RightsizingClusterUtilization.d.ts +12 -12
  95. package/dist/models/RightsizingClusterUtilization.js +36 -36
  96. package/dist/models/RightsizingCollectRequest.d.ts +6 -6
  97. package/dist/models/RightsizingCollectRequest.js +12 -12
  98. package/dist/models/RightsizingMetricStats.d.ts +1 -1
  99. package/dist/models/RightsizingMetricStats.js +3 -3
  100. package/dist/models/RightsizingReport.d.ts +6 -6
  101. package/dist/models/RightsizingReport.js +18 -18
  102. package/dist/models/RightsizingReportSummary.d.ts +6 -6
  103. package/dist/models/RightsizingReportSummary.js +18 -18
  104. package/dist/models/UpdateGroupRequest.d.ts +0 -6
  105. package/dist/models/UpdateGroupRequest.js +0 -2
  106. package/dist/models/UpdateLabelVMsRequest.d.ts +38 -0
  107. package/dist/models/UpdateLabelVMsRequest.js +50 -0
  108. package/dist/models/VMFilterOptionsResponse.d.ts +56 -0
  109. package/dist/models/VMFilterOptionsResponse.js +66 -0
  110. package/dist/models/VMLabelsResponse.d.ts +38 -0
  111. package/dist/models/VMLabelsResponse.js +54 -0
  112. package/dist/models/VMNIC.d.ts +12 -0
  113. package/dist/models/VMNIC.js +4 -0
  114. package/dist/models/VirtualMachine.d.ts +30 -6
  115. package/dist/models/VirtualMachine.js +18 -10
  116. package/dist/models/VirtualMachineDetail.d.ts +12 -0
  117. package/dist/models/VirtualMachineDetail.js +4 -0
  118. package/dist/models/VirtualMachineUpdateRequest.d.ts +38 -0
  119. package/dist/models/VirtualMachineUpdateRequest.js +50 -0
  120. package/dist/models/VmUtilizationDetails.d.ts +12 -12
  121. package/dist/models/VmUtilizationDetails.js +36 -36
  122. package/dist/models/index.d.ts +11 -0
  123. package/dist/models/index.js +11 -0
  124. package/docs/AgentStatus.md +2 -2
  125. package/docs/ApplicationListResponse.md +34 -0
  126. package/docs/ApplicationOverview.md +40 -0
  127. package/docs/ApplicationVM.md +36 -0
  128. package/docs/ClusterFeatures.md +38 -0
  129. package/docs/ClusterUtilization.md +46 -0
  130. package/docs/CreateGroupRequest.md +0 -2
  131. package/docs/DefaultApi.md +679 -79
  132. package/docs/DeleteLabelGloballyResponse.md +36 -0
  133. package/docs/GetInventory200Response.md +4 -2
  134. package/docs/Group.md +0 -2
  135. package/docs/GroupResponse.md +2 -0
  136. package/docs/Inventory.md +4 -2
  137. package/docs/InventoryData.md +4 -0
  138. package/docs/RightsizingClusterListResponse.md +2 -2
  139. package/docs/RightsizingClusterResponse.md +36 -0
  140. package/docs/RightsizingClusterUtilization.md +24 -24
  141. package/docs/RightsizingCollectRequest.md +12 -12
  142. package/docs/RightsizingMetricStats.md +2 -2
  143. package/docs/RightsizingReport.md +12 -12
  144. package/docs/RightsizingReportSummary.md +12 -12
  145. package/docs/UpdateGroupRequest.md +0 -2
  146. package/docs/UpdateLabelVMsRequest.md +36 -0
  147. package/docs/VMFilterOptionsResponse.md +42 -0
  148. package/docs/VMLabelsResponse.md +36 -0
  149. package/docs/VMNIC.md +4 -0
  150. package/docs/VirtualMachine.md +18 -10
  151. package/docs/VirtualMachineDetail.md +4 -0
  152. package/docs/VirtualMachineUpdateRequest.md +36 -0
  153. package/docs/VmUtilizationDetails.md +24 -24
  154. package/package.json +1 -1
  155. package/src/apis/DefaultApi.ts +806 -111
  156. package/src/models/AgentStatus.ts +4 -4
  157. package/src/models/ApplicationListResponse.ts +74 -0
  158. package/src/models/ApplicationOverview.ts +101 -0
  159. package/src/models/ApplicationVM.ts +75 -0
  160. package/src/models/ClusterFeatures.ts +94 -0
  161. package/src/models/ClusterUtilization.ts +120 -0
  162. package/src/models/CreateGroupRequest.ts +0 -8
  163. package/src/models/DeleteLabelGloballyResponse.ts +75 -0
  164. package/src/models/Group.ts +0 -8
  165. package/src/models/GroupResponse.ts +15 -0
  166. package/src/models/Inventory.ts +12 -4
  167. package/src/models/InventoryData.ts +30 -0
  168. package/src/models/RightsizingClusterListResponse.ts +4 -4
  169. package/src/models/RightsizingClusterResponse.ts +83 -0
  170. package/src/models/RightsizingClusterUtilization.ts +48 -48
  171. package/src/models/RightsizingCollectRequest.ts +18 -18
  172. package/src/models/RightsizingMetricStats.ts +4 -4
  173. package/src/models/RightsizingReport.ts +24 -24
  174. package/src/models/RightsizingReportSummary.ts +24 -24
  175. package/src/models/UpdateGroupRequest.ts +0 -8
  176. package/src/models/UpdateLabelVMsRequest.ts +73 -0
  177. package/src/models/VMFilterOptionsResponse.ts +102 -0
  178. package/src/models/VMLabelsResponse.ts +75 -0
  179. package/src/models/VMNIC.ts +16 -0
  180. package/src/models/VirtualMachine.ts +48 -16
  181. package/src/models/VirtualMachineDetail.ts +16 -0
  182. package/src/models/VirtualMachineUpdateRequest.ts +73 -0
  183. package/src/models/VmUtilizationDetails.ts +48 -48
  184. package/src/models/index.ts +11 -0
@@ -7,7 +7,10 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
7
7
  | [**createGroup**](DefaultApi.md#creategroupoperation) | **POST** /groups | Create a new group |
8
8
  | [**deleteForecasterRun**](DefaultApi.md#deleteforecasterrun) | **DELETE** /forecaster/runs/{id} | Delete a benchmark run |
9
9
  | [**deleteGroup**](DefaultApi.md#deletegroup) | **DELETE** /groups/{id} | Delete group |
10
+ | [**deleteLabelGlobally**](DefaultApi.md#deletelabelglobally) | **DELETE** /vms/labels/{label} | Delete label from all VMs |
10
11
  | [**getAgentStatus**](DefaultApi.md#getagentstatus) | **GET** /agent | Get agent status |
12
+ | [**getApplications**](DefaultApi.md#getapplications) | **GET** /applications | List detected applications running on VMs |
13
+ | [**getClusterUtilization**](DefaultApi.md#getclusterutilization) | **GET** /clusters/{cluster_id}/utilization | Get latest cluster utilization by cluster ID |
11
14
  | [**getCollectorStatus**](DefaultApi.md#getcollectorstatus) | **GET** /collector | Get collector status |
12
15
  | [**getForecasterDatastores**](DefaultApi.md#getforecasterdatastores) | **POST** /forecaster/datastores | List available datastores |
13
16
  | [**getForecasterRuns**](DefaultApi.md#getforecasterruns) | **GET** /forecaster/runs | List benchmark runs |
@@ -18,17 +21,20 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
18
21
  | [**getInspectorVddkStatus**](DefaultApi.md#getinspectorvddkstatus) | **GET** /inspector/vddk | Get VDDK status |
19
22
  | [**getInventory**](DefaultApi.md#getinventory) | **GET** /inventory | Get collected inventory |
20
23
  | [**getLatestRightsizingClusters**](DefaultApi.md#getlatestrightsizingclusters) | **GET** /cluster_rightsizing | Get cluster-level utilization aggregates for the latest completed report |
21
- | [**getRightsizingReport**](DefaultApi.md#getrightsizingreport) | **GET** /rightsizing/{id} | Get a specific rightsizing report with full VM metrics |
24
+ | [**getRightsizingReport**](DefaultApi.md#getrightsizingreport) | **GET** /rightsizing/{report_id} | Get a specific rightsizing report with full VM metrics |
25
+ | [**getRightsizingReportCluster**](DefaultApi.md#getrightsizingreportcluster) | **GET** /rightsizing/{report_id}/clusters/{cluster_id} | Get utilization for a specific cluster from a specific report |
22
26
  | [**getRightsizingReportClusters**](DefaultApi.md#getrightsizingreportclusters) | **GET** /cluster_rightsizing/{report_id} | Get cluster-level utilization aggregates for a specific report |
23
27
  | [**getVM**](DefaultApi.md#getvm) | **GET** /vms/{id} | Get details about a vm |
28
+ | [**getVMLabels**](DefaultApi.md#getvmlabels) | **GET** /vms/labels | Get all distinct labels in use across VMs |
24
29
  | [**getVMUtilization**](DefaultApi.md#getvmutilization) | **GET** /vms/{id}/utilization | Get utilization breakdown for a specific VM |
25
30
  | [**getVMs**](DefaultApi.md#getvms) | **GET** /vms | Get list of VMs with filtering and pagination |
31
+ | [**getVMsFilterOptions**](DefaultApi.md#getvmsfilteroptions) | **GET** /vms/filter-options | Get distinct filter option values for VMs |
26
32
  | [**getVersion**](DefaultApi.md#getversion) | **GET** /version | Get agent version information |
27
33
  | [**listGroups**](DefaultApi.md#listgroups) | **GET** /groups | List all groups |
34
+ | [**listRightsizingReportClusters**](DefaultApi.md#listrightsizingreportclusters) | **GET** /rightsizing/{report_id}/clusters | Get cluster-level utilization aggregates for a specific report |
28
35
  | [**listRightsizingReports**](DefaultApi.md#listrightsizingreports) | **GET** /rightsizing | List all rightsizing reports |
29
36
  | [**postForecasterPairCapabilities**](DefaultApi.md#postforecasterpaircapabilities) | **POST** /forecaster/capabilities | Compute pair capabilities |
30
37
  | [**putForecasterCredentials**](DefaultApi.md#putforecastercredentials) | **PUT** /forecaster/credentials | Verify vCenter credentials and permissions |
31
- | [**putInspectorCredentials**](DefaultApi.md#putinspectorcredentials) | **PUT** /inspector/credentials | Set or replace inspector credentials |
32
38
  | [**putInspectorVddk**](DefaultApi.md#putinspectorvddk) | **PUT** /inspector/vddk | Upload VDDK tarball |
33
39
  | [**removeVMFromInspection**](DefaultApi.md#removevmfrominspection) | **DELETE** /vms/{id}/inspection | Remove VirtualMachine from inspection queue |
34
40
  | [**setAgentMode**](DefaultApi.md#setagentmode) | **POST** /agent | Change agent mode |
@@ -41,6 +47,9 @@ All URIs are relative to *https://raw.githubusercontent.com/api/v1*
41
47
  | [**stopInspection**](DefaultApi.md#stopinspection) | **DELETE** /inspector | Stop inspector entirely |
42
48
  | [**triggerRightsizingCollection**](DefaultApi.md#triggerrightsizingcollection) | **POST** /rightsizing | Trigger rightsizing metrics collection |
43
49
  | [**updateGroup**](DefaultApi.md#updategroupoperation) | **PATCH** /groups/{id} | Update group |
50
+ | [**updateLabelVMs**](DefaultApi.md#updatelabelvmsoperation) | **PATCH** /vms/labels/{label} | Modify label VM membership (add/remove label to/from VMs) |
51
+ | [**updateVM**](DefaultApi.md#updatevm) | **PATCH** /vms/{id} | Update VM properties |
52
+ | [**validateInspectorCredentials**](DefaultApi.md#validateinspectorcredentials) | **POST** /inspector/credentials | Validate vCenter credentials for inspector |
44
53
 
45
54
 
46
55
 
@@ -245,6 +254,73 @@ No authorization required
245
254
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
246
255
 
247
256
 
257
+ ## deleteLabelGlobally
258
+
259
+ > DeleteLabelGloballyResponse deleteLabelGlobally(label)
260
+
261
+ Delete label from all VMs
262
+
263
+ ### Example
264
+
265
+ ```ts
266
+ import {
267
+ Configuration,
268
+ DefaultApi,
269
+ } from '@openshift-migration-advisor/agent-sdk';
270
+ import type { DeleteLabelGloballyRequest } from '@openshift-migration-advisor/agent-sdk';
271
+
272
+ async function example() {
273
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
274
+ const api = new DefaultApi();
275
+
276
+ const body = {
277
+ // string | The label to remove from all VMs
278
+ label: label_example,
279
+ } satisfies DeleteLabelGloballyRequest;
280
+
281
+ try {
282
+ const data = await api.deleteLabelGlobally(body);
283
+ console.log(data);
284
+ } catch (error) {
285
+ console.error(error);
286
+ }
287
+ }
288
+
289
+ // Run the test
290
+ example().catch(console.error);
291
+ ```
292
+
293
+ ### Parameters
294
+
295
+
296
+ | Name | Type | Description | Notes |
297
+ |------------- | ------------- | ------------- | -------------|
298
+ | **label** | `string` | The label to remove from all VMs | [Defaults to `undefined`] |
299
+
300
+ ### Return type
301
+
302
+ [**DeleteLabelGloballyResponse**](DeleteLabelGloballyResponse.md)
303
+
304
+ ### Authorization
305
+
306
+ No authorization required
307
+
308
+ ### HTTP request headers
309
+
310
+ - **Content-Type**: Not defined
311
+ - **Accept**: `application/json`
312
+
313
+
314
+ ### HTTP response details
315
+ | Status code | Description | Response headers |
316
+ |-------------|-------------|------------------|
317
+ | **200** | Label removed globally | - |
318
+ | **400** | Invalid label parameter | - |
319
+ | **500** | Internal server error | - |
320
+
321
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
322
+
323
+
248
324
  ## getAgentStatus
249
325
 
250
326
  > AgentStatus getAgentStatus()
@@ -303,6 +379,132 @@ No authorization required
303
379
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
304
380
 
305
381
 
382
+ ## getApplications
383
+
384
+ > ApplicationListResponse getApplications()
385
+
386
+ List detected applications running on VMs
387
+
388
+ ### Example
389
+
390
+ ```ts
391
+ import {
392
+ Configuration,
393
+ DefaultApi,
394
+ } from '@openshift-migration-advisor/agent-sdk';
395
+ import type { GetApplicationsRequest } from '@openshift-migration-advisor/agent-sdk';
396
+
397
+ async function example() {
398
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
399
+ const api = new DefaultApi();
400
+
401
+ try {
402
+ const data = await api.getApplications();
403
+ console.log(data);
404
+ } catch (error) {
405
+ console.error(error);
406
+ }
407
+ }
408
+
409
+ // Run the test
410
+ example().catch(console.error);
411
+ ```
412
+
413
+ ### Parameters
414
+
415
+ This endpoint does not need any parameter.
416
+
417
+ ### Return type
418
+
419
+ [**ApplicationListResponse**](ApplicationListResponse.md)
420
+
421
+ ### Authorization
422
+
423
+ No authorization required
424
+
425
+ ### HTTP request headers
426
+
427
+ - **Content-Type**: Not defined
428
+ - **Accept**: `application/json`
429
+
430
+
431
+ ### HTTP response details
432
+ | Status code | Description | Response headers |
433
+ |-------------|-------------|------------------|
434
+ | **200** | List of applications with matching VMs | - |
435
+ | **500** | Internal server error | - |
436
+
437
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
438
+
439
+
440
+ ## getClusterUtilization
441
+
442
+ > RightsizingClusterResponse getClusterUtilization(clusterId)
443
+
444
+ Get latest cluster utilization by cluster ID
445
+
446
+ ### Example
447
+
448
+ ```ts
449
+ import {
450
+ Configuration,
451
+ DefaultApi,
452
+ } from '@openshift-migration-advisor/agent-sdk';
453
+ import type { GetClusterUtilizationRequest } from '@openshift-migration-advisor/agent-sdk';
454
+
455
+ async function example() {
456
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
457
+ const api = new DefaultApi();
458
+
459
+ const body = {
460
+ // string | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\")
461
+ clusterId: clusterId_example,
462
+ } satisfies GetClusterUtilizationRequest;
463
+
464
+ try {
465
+ const data = await api.getClusterUtilization(body);
466
+ console.log(data);
467
+ } catch (error) {
468
+ console.error(error);
469
+ }
470
+ }
471
+
472
+ // Run the test
473
+ example().catch(console.error);
474
+ ```
475
+
476
+ ### Parameters
477
+
478
+
479
+ | Name | Type | Description | Notes |
480
+ |------------- | ------------- | ------------- | -------------|
481
+ | **clusterId** | `string` | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\") | [Defaults to `undefined`] |
482
+
483
+ ### Return type
484
+
485
+ [**RightsizingClusterResponse**](RightsizingClusterResponse.md)
486
+
487
+ ### Authorization
488
+
489
+ No authorization required
490
+
491
+ ### HTTP request headers
492
+
493
+ - **Content-Type**: Not defined
494
+ - **Accept**: `application/json`
495
+
496
+
497
+ ### HTTP response details
498
+ | Status code | Description | Response headers |
499
+ |-------------|-------------|------------------|
500
+ | **200** | Cluster utilization data from the latest completed rightsizing report | - |
501
+ | **400** | Invalid cluster_id format | - |
502
+ | **404** | No completed rightsizing report found, or cluster not found in report | - |
503
+ | **500** | Internal server error | - |
504
+
505
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
506
+
507
+
306
508
  ## getCollectorStatus
307
509
 
308
510
  > CollectorStatus getCollectorStatus()
@@ -965,7 +1167,7 @@ No authorization required
965
1167
 
966
1168
  ## getRightsizingReport
967
1169
 
968
- > RightsizingReport getRightsizingReport(id)
1170
+ > RightsizingReport getRightsizingReport(reportId)
969
1171
 
970
1172
  Get a specific rightsizing report with full VM metrics
971
1173
 
@@ -984,7 +1186,7 @@ async function example() {
984
1186
 
985
1187
  const body = {
986
1188
  // string | Report UUID
987
- id: id_example,
1189
+ reportId: reportId_example,
988
1190
  } satisfies GetRightsizingReportRequest;
989
1191
 
990
1192
  try {
@@ -1004,7 +1206,7 @@ example().catch(console.error);
1004
1206
 
1005
1207
  | Name | Type | Description | Notes |
1006
1208
  |------------- | ------------- | ------------- | -------------|
1007
- | **id** | `string` | Report UUID | [Defaults to `undefined`] |
1209
+ | **reportId** | `string` | Report UUID | [Defaults to `undefined`] |
1008
1210
 
1009
1211
  ### Return type
1010
1212
 
@@ -1030,6 +1232,76 @@ No authorization required
1030
1232
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1031
1233
 
1032
1234
 
1235
+ ## getRightsizingReportCluster
1236
+
1237
+ > RightsizingClusterResponse getRightsizingReportCluster(reportId, clusterId)
1238
+
1239
+ Get utilization for a specific cluster from a specific report
1240
+
1241
+ ### Example
1242
+
1243
+ ```ts
1244
+ import {
1245
+ Configuration,
1246
+ DefaultApi,
1247
+ } from '@openshift-migration-advisor/agent-sdk';
1248
+ import type { GetRightsizingReportClusterRequest } from '@openshift-migration-advisor/agent-sdk';
1249
+
1250
+ async function example() {
1251
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1252
+ const api = new DefaultApi();
1253
+
1254
+ const body = {
1255
+ // string | Rightsizing report UUID
1256
+ reportId: reportId_example,
1257
+ // string | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\")
1258
+ clusterId: clusterId_example,
1259
+ } satisfies GetRightsizingReportClusterRequest;
1260
+
1261
+ try {
1262
+ const data = await api.getRightsizingReportCluster(body);
1263
+ console.log(data);
1264
+ } catch (error) {
1265
+ console.error(error);
1266
+ }
1267
+ }
1268
+
1269
+ // Run the test
1270
+ example().catch(console.error);
1271
+ ```
1272
+
1273
+ ### Parameters
1274
+
1275
+
1276
+ | Name | Type | Description | Notes |
1277
+ |------------- | ------------- | ------------- | -------------|
1278
+ | **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
1279
+ | **clusterId** | `string` | vSphere MoRef (e.g. \"domain-c123\") or generated cluster ID (e.g. \"cluster-a3f7b2c1d4e89012\") | [Defaults to `undefined`] |
1280
+
1281
+ ### Return type
1282
+
1283
+ [**RightsizingClusterResponse**](RightsizingClusterResponse.md)
1284
+
1285
+ ### Authorization
1286
+
1287
+ No authorization required
1288
+
1289
+ ### HTTP request headers
1290
+
1291
+ - **Content-Type**: Not defined
1292
+ - **Accept**: `application/json`
1293
+
1294
+
1295
+ ### HTTP response details
1296
+ | Status code | Description | Response headers |
1297
+ |-------------|-------------|------------------|
1298
+ | **200** | Cluster utilization data | - |
1299
+ | **404** | Report not found, or cluster not found in report | - |
1300
+ | **500** | Internal server error | - |
1301
+
1302
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1303
+
1304
+
1033
1305
  ## getRightsizingReportClusters
1034
1306
 
1035
1307
  > RightsizingClusterListResponse getRightsizingReportClusters(reportId, byExpression)
@@ -1167,6 +1439,64 @@ No authorization required
1167
1439
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1168
1440
 
1169
1441
 
1442
+ ## getVMLabels
1443
+
1444
+ > VMLabelsResponse getVMLabels()
1445
+
1446
+ Get all distinct labels in use across VMs
1447
+
1448
+ ### Example
1449
+
1450
+ ```ts
1451
+ import {
1452
+ Configuration,
1453
+ DefaultApi,
1454
+ } from '@openshift-migration-advisor/agent-sdk';
1455
+ import type { GetVMLabelsRequest } from '@openshift-migration-advisor/agent-sdk';
1456
+
1457
+ async function example() {
1458
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1459
+ const api = new DefaultApi();
1460
+
1461
+ try {
1462
+ const data = await api.getVMLabels();
1463
+ console.log(data);
1464
+ } catch (error) {
1465
+ console.error(error);
1466
+ }
1467
+ }
1468
+
1469
+ // Run the test
1470
+ example().catch(console.error);
1471
+ ```
1472
+
1473
+ ### Parameters
1474
+
1475
+ This endpoint does not need any parameter.
1476
+
1477
+ ### Return type
1478
+
1479
+ [**VMLabelsResponse**](VMLabelsResponse.md)
1480
+
1481
+ ### Authorization
1482
+
1483
+ No authorization required
1484
+
1485
+ ### HTTP request headers
1486
+
1487
+ - **Content-Type**: Not defined
1488
+ - **Accept**: `application/json`
1489
+
1490
+
1491
+ ### HTTP response details
1492
+ | Status code | Description | Response headers |
1493
+ |-------------|-------------|------------------|
1494
+ | **200** | List of distinct labels | - |
1495
+ | **500** | Internal server error | - |
1496
+
1497
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1498
+
1499
+
1170
1500
  ## getVMUtilization
1171
1501
 
1172
1502
  > VmUtilizationDetails getVMUtilization(id)
@@ -1310,6 +1640,64 @@ No authorization required
1310
1640
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1311
1641
 
1312
1642
 
1643
+ ## getVMsFilterOptions
1644
+
1645
+ > VMFilterOptionsResponse getVMsFilterOptions()
1646
+
1647
+ Get distinct filter option values for VMs
1648
+
1649
+ ### Example
1650
+
1651
+ ```ts
1652
+ import {
1653
+ Configuration,
1654
+ DefaultApi,
1655
+ } from '@openshift-migration-advisor/agent-sdk';
1656
+ import type { GetVMsFilterOptionsRequest } from '@openshift-migration-advisor/agent-sdk';
1657
+
1658
+ async function example() {
1659
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1660
+ const api = new DefaultApi();
1661
+
1662
+ try {
1663
+ const data = await api.getVMsFilterOptions();
1664
+ console.log(data);
1665
+ } catch (error) {
1666
+ console.error(error);
1667
+ }
1668
+ }
1669
+
1670
+ // Run the test
1671
+ example().catch(console.error);
1672
+ ```
1673
+
1674
+ ### Parameters
1675
+
1676
+ This endpoint does not need any parameter.
1677
+
1678
+ ### Return type
1679
+
1680
+ [**VMFilterOptionsResponse**](VMFilterOptionsResponse.md)
1681
+
1682
+ ### Authorization
1683
+
1684
+ No authorization required
1685
+
1686
+ ### HTTP request headers
1687
+
1688
+ - **Content-Type**: Not defined
1689
+ - **Accept**: `application/json`
1690
+
1691
+
1692
+ ### HTTP response details
1693
+ | Status code | Description | Response headers |
1694
+ |-------------|-------------|------------------|
1695
+ | **200** | Filter options | - |
1696
+ | **500** | Internal server error | - |
1697
+
1698
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1699
+
1700
+
1313
1701
  ## getVersion
1314
1702
 
1315
1703
  > VersionInfo getVersion()
@@ -1396,7 +1784,78 @@ async function example() {
1396
1784
  } satisfies ListGroupsRequest;
1397
1785
 
1398
1786
  try {
1399
- const data = await api.listGroups(body);
1787
+ const data = await api.listGroups(body);
1788
+ console.log(data);
1789
+ } catch (error) {
1790
+ console.error(error);
1791
+ }
1792
+ }
1793
+
1794
+ // Run the test
1795
+ example().catch(console.error);
1796
+ ```
1797
+
1798
+ ### Parameters
1799
+
1800
+
1801
+ | Name | Type | Description | Notes |
1802
+ |------------- | ------------- | ------------- | -------------|
1803
+ | **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
1804
+ | **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
1805
+ | **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
1806
+
1807
+ ### Return type
1808
+
1809
+ [**GroupListResponse**](GroupListResponse.md)
1810
+
1811
+ ### Authorization
1812
+
1813
+ No authorization required
1814
+
1815
+ ### HTTP request headers
1816
+
1817
+ - **Content-Type**: Not defined
1818
+ - **Accept**: `application/json`
1819
+
1820
+
1821
+ ### HTTP response details
1822
+ | Status code | Description | Response headers |
1823
+ |-------------|-------------|------------------|
1824
+ | **200** | List of groups | - |
1825
+ | **400** | Invalid filter expression | - |
1826
+ | **500** | Internal server error | - |
1827
+
1828
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1829
+
1830
+
1831
+ ## listRightsizingReportClusters
1832
+
1833
+ > RightsizingClusterListResponse listRightsizingReportClusters(reportId, byExpression)
1834
+
1835
+ Get cluster-level utilization aggregates for a specific report
1836
+
1837
+ ### Example
1838
+
1839
+ ```ts
1840
+ import {
1841
+ Configuration,
1842
+ DefaultApi,
1843
+ } from '@openshift-migration-advisor/agent-sdk';
1844
+ import type { ListRightsizingReportClustersRequest } from '@openshift-migration-advisor/agent-sdk';
1845
+
1846
+ async function example() {
1847
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1848
+ const api = new DefaultApi();
1849
+
1850
+ const body = {
1851
+ // string | Rightsizing report UUID
1852
+ reportId: reportId_example,
1853
+ // string | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. (optional)
1854
+ byExpression: byExpression_example,
1855
+ } satisfies ListRightsizingReportClustersRequest;
1856
+
1857
+ try {
1858
+ const data = await api.listRightsizingReportClusters(body);
1400
1859
  console.log(data);
1401
1860
  } catch (error) {
1402
1861
  console.error(error);
@@ -1412,13 +1871,12 @@ example().catch(console.error);
1412
1871
 
1413
1872
  | Name | Type | Description | Notes |
1414
1873
  |------------- | ------------- | ------------- | -------------|
1415
- | **byName** | `string` | Filter groups by name (case-insensitive substring match) | [Optional] [Defaults to `undefined`] |
1416
- | **page** | `number` | Page number (1-indexed) | [Optional] [Defaults to `1`] |
1417
- | **pageSize** | `number` | Number of groups per page | [Optional] [Defaults to `20`] |
1874
+ | **reportId** | `string` | Rightsizing report UUID | [Defaults to `undefined`] |
1875
+ | **byExpression** | `string` | Filter DSL expression (e.g. \"cluster_id = \'domain-c123\'\"). Omit to return all clusters. | [Optional] [Defaults to `undefined`] |
1418
1876
 
1419
1877
  ### Return type
1420
1878
 
1421
- [**GroupListResponse**](GroupListResponse.md)
1879
+ [**RightsizingClusterListResponse**](RightsizingClusterListResponse.md)
1422
1880
 
1423
1881
  ### Authorization
1424
1882
 
@@ -1433,8 +1891,8 @@ No authorization required
1433
1891
  ### HTTP response details
1434
1892
  | Status code | Description | Response headers |
1435
1893
  |-------------|-------------|------------------|
1436
- | **200** | List of groups | - |
1437
- | **400** | Invalid filter expression | - |
1894
+ | **200** | Cluster utilization aggregates | - |
1895
+ | **404** | Report not found | - |
1438
1896
  | **500** | Internal server error | - |
1439
1897
 
1440
1898
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
@@ -1637,73 +2095,6 @@ No authorization required
1637
2095
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1638
2096
 
1639
2097
 
1640
- ## putInspectorCredentials
1641
-
1642
- > putInspectorCredentials(vcenterCredentials)
1643
-
1644
- Set or replace inspector credentials
1645
-
1646
- ### Example
1647
-
1648
- ```ts
1649
- import {
1650
- Configuration,
1651
- DefaultApi,
1652
- } from '@openshift-migration-advisor/agent-sdk';
1653
- import type { PutInspectorCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
1654
-
1655
- async function example() {
1656
- console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
1657
- const api = new DefaultApi();
1658
-
1659
- const body = {
1660
- // VcenterCredentials
1661
- vcenterCredentials: ...,
1662
- } satisfies PutInspectorCredentialsRequest;
1663
-
1664
- try {
1665
- const data = await api.putInspectorCredentials(body);
1666
- console.log(data);
1667
- } catch (error) {
1668
- console.error(error);
1669
- }
1670
- }
1671
-
1672
- // Run the test
1673
- example().catch(console.error);
1674
- ```
1675
-
1676
- ### Parameters
1677
-
1678
-
1679
- | Name | Type | Description | Notes |
1680
- |------------- | ------------- | ------------- | -------------|
1681
- | **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
1682
-
1683
- ### Return type
1684
-
1685
- `void` (Empty response body)
1686
-
1687
- ### Authorization
1688
-
1689
- No authorization required
1690
-
1691
- ### HTTP request headers
1692
-
1693
- - **Content-Type**: `application/json`
1694
- - **Accept**: Not defined
1695
-
1696
-
1697
- ### HTTP response details
1698
- | Status code | Description | Response headers |
1699
- |-------------|-------------|------------------|
1700
- | **200** | Credentials updated successfully | - |
1701
- | **400** | Bad Credentials | - |
1702
- | **500** | Internal server error | - |
1703
-
1704
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1705
-
1706
-
1707
2098
  ## putInspectorVddk
1708
2099
 
1709
2100
  > VddkProperties putInspectorVddk(file)
@@ -2500,3 +2891,212 @@ No authorization required
2500
2891
 
2501
2892
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2502
2893
 
2894
+
2895
+ ## updateLabelVMs
2896
+
2897
+ > updateLabelVMs(label, updateLabelVMsRequest)
2898
+
2899
+ Modify label VM membership (add/remove label to/from VMs)
2900
+
2901
+ ### Example
2902
+
2903
+ ```ts
2904
+ import {
2905
+ Configuration,
2906
+ DefaultApi,
2907
+ } from '@openshift-migration-advisor/agent-sdk';
2908
+ import type { UpdateLabelVMsOperationRequest } from '@openshift-migration-advisor/agent-sdk';
2909
+
2910
+ async function example() {
2911
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
2912
+ const api = new DefaultApi();
2913
+
2914
+ const body = {
2915
+ // string | The label to modify
2916
+ label: label_example,
2917
+ // UpdateLabelVMsRequest
2918
+ updateLabelVMsRequest: ...,
2919
+ } satisfies UpdateLabelVMsOperationRequest;
2920
+
2921
+ try {
2922
+ const data = await api.updateLabelVMs(body);
2923
+ console.log(data);
2924
+ } catch (error) {
2925
+ console.error(error);
2926
+ }
2927
+ }
2928
+
2929
+ // Run the test
2930
+ example().catch(console.error);
2931
+ ```
2932
+
2933
+ ### Parameters
2934
+
2935
+
2936
+ | Name | Type | Description | Notes |
2937
+ |------------- | ------------- | ------------- | -------------|
2938
+ | **label** | `string` | The label to modify | [Defaults to `undefined`] |
2939
+ | **updateLabelVMsRequest** | [UpdateLabelVMsRequest](UpdateLabelVMsRequest.md) | | |
2940
+
2941
+ ### Return type
2942
+
2943
+ `void` (Empty response body)
2944
+
2945
+ ### Authorization
2946
+
2947
+ No authorization required
2948
+
2949
+ ### HTTP request headers
2950
+
2951
+ - **Content-Type**: `application/json`
2952
+ - **Accept**: Not defined
2953
+
2954
+
2955
+ ### HTTP response details
2956
+ | Status code | Description | Response headers |
2957
+ |-------------|-------------|------------------|
2958
+ | **200** | Label operation completed successfully (all VMs updated atomically) | - |
2959
+ | **400** | Invalid request | - |
2960
+ | **404** | One or more VMs not found (no changes made) | - |
2961
+ | **500** | Internal server error | - |
2962
+
2963
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2964
+
2965
+
2966
+ ## updateVM
2967
+
2968
+ > updateVM(id, virtualMachineUpdateRequest)
2969
+
2970
+ Update VM properties
2971
+
2972
+ ### Example
2973
+
2974
+ ```ts
2975
+ import {
2976
+ Configuration,
2977
+ DefaultApi,
2978
+ } from '@openshift-migration-advisor/agent-sdk';
2979
+ import type { UpdateVMRequest } from '@openshift-migration-advisor/agent-sdk';
2980
+
2981
+ async function example() {
2982
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
2983
+ const api = new DefaultApi();
2984
+
2985
+ const body = {
2986
+ // string | VirtualMachine id
2987
+ id: id_example,
2988
+ // VirtualMachineUpdateRequest
2989
+ virtualMachineUpdateRequest: ...,
2990
+ } satisfies UpdateVMRequest;
2991
+
2992
+ try {
2993
+ const data = await api.updateVM(body);
2994
+ console.log(data);
2995
+ } catch (error) {
2996
+ console.error(error);
2997
+ }
2998
+ }
2999
+
3000
+ // Run the test
3001
+ example().catch(console.error);
3002
+ ```
3003
+
3004
+ ### Parameters
3005
+
3006
+
3007
+ | Name | Type | Description | Notes |
3008
+ |------------- | ------------- | ------------- | -------------|
3009
+ | **id** | `string` | VirtualMachine id | [Defaults to `undefined`] |
3010
+ | **virtualMachineUpdateRequest** | [VirtualMachineUpdateRequest](VirtualMachineUpdateRequest.md) | | |
3011
+
3012
+ ### Return type
3013
+
3014
+ `void` (Empty response body)
3015
+
3016
+ ### Authorization
3017
+
3018
+ No authorization required
3019
+
3020
+ ### HTTP request headers
3021
+
3022
+ - **Content-Type**: `application/json`
3023
+ - **Accept**: Not defined
3024
+
3025
+
3026
+ ### HTTP response details
3027
+ | Status code | Description | Response headers |
3028
+ |-------------|-------------|------------------|
3029
+ | **200** | VM updated successfully | - |
3030
+ | **400** | Invalid request | - |
3031
+ | **404** | VM not found | - |
3032
+ | **500** | Internal server error | - |
3033
+
3034
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
3035
+
3036
+
3037
+ ## validateInspectorCredentials
3038
+
3039
+ > validateInspectorCredentials(vcenterCredentials)
3040
+
3041
+ Validate vCenter credentials for inspector
3042
+
3043
+ ### Example
3044
+
3045
+ ```ts
3046
+ import {
3047
+ Configuration,
3048
+ DefaultApi,
3049
+ } from '@openshift-migration-advisor/agent-sdk';
3050
+ import type { ValidateInspectorCredentialsRequest } from '@openshift-migration-advisor/agent-sdk';
3051
+
3052
+ async function example() {
3053
+ console.log("🚀 Testing @openshift-migration-advisor/agent-sdk SDK...");
3054
+ const api = new DefaultApi();
3055
+
3056
+ const body = {
3057
+ // VcenterCredentials
3058
+ vcenterCredentials: ...,
3059
+ } satisfies ValidateInspectorCredentialsRequest;
3060
+
3061
+ try {
3062
+ const data = await api.validateInspectorCredentials(body);
3063
+ console.log(data);
3064
+ } catch (error) {
3065
+ console.error(error);
3066
+ }
3067
+ }
3068
+
3069
+ // Run the test
3070
+ example().catch(console.error);
3071
+ ```
3072
+
3073
+ ### Parameters
3074
+
3075
+
3076
+ | Name | Type | Description | Notes |
3077
+ |------------- | ------------- | ------------- | -------------|
3078
+ | **vcenterCredentials** | [VcenterCredentials](VcenterCredentials.md) | | |
3079
+
3080
+ ### Return type
3081
+
3082
+ `void` (Empty response body)
3083
+
3084
+ ### Authorization
3085
+
3086
+ No authorization required
3087
+
3088
+ ### HTTP request headers
3089
+
3090
+ - **Content-Type**: `application/json`
3091
+ - **Accept**: Not defined
3092
+
3093
+
3094
+ ### HTTP response details
3095
+ | Status code | Description | Response headers |
3096
+ |-------------|-------------|------------------|
3097
+ | **200** | Credentials updated successfully | - |
3098
+ | **400** | Bad Credentials | - |
3099
+ | **500** | Internal server error | - |
3100
+
3101
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
3102
+