Skip to content

Latest commit

 

History

History
211 lines (131 loc) · 6.68 KB

VMsApi.md

File metadata and controls

211 lines (131 loc) · 6.68 KB

{{classname}}

All URIs are relative to **

Method HTTP request Description
InventoryControllerUpdateVM Patch /api/v2/vms/{vmId} Updates VM information
VMMicroserviceControllerGetRemoteConsoleInfo Get /api/v2/vms/{vmId}/remote-console-info Get Remote Console information
VMMicroserviceControllerGetVM Get /api/v2/vms/{vmId} Retrieves the VM information
VMMicroserviceControllerPowerStatusVMInstance Get /api/v2/vms/{vmId}/power-status Retrieves the power status of the VM
VMMicroserviceControllerRebootVM Post /api/v2/vms/{vmId}/reboot Reboots the VM
VMMicroserviceControllerShutdownVM Post /api/v2/vms/{vmId}/shutdown Shuts down the VM
VMMicroserviceControllerStartVM Post /api/v2/vms/{vmId}/start Starts the VM

InventoryControllerUpdateVM

Vm InventoryControllerUpdateVM(ctx, body, vmId) Updates VM information

Updates VM information

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body UpdateVm The VM update object
vmId float64

Return type

Vm

Authorization

JWT, apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VMMicroserviceControllerGetRemoteConsoleInfo

[]RemoteConsoleInfoDto VMMicroserviceControllerGetRemoteConsoleInfo(ctx, vmId) Get Remote Console information

Returns Remote Console information

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmId float64

Return type

[]RemoteConsoleInfoDto

Authorization

JWT, apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VMMicroserviceControllerGetVM

VMMicroserviceControllerGetVM(ctx, vmId) Retrieves the VM information

Retrieves the VM information

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmId float64

Return type

(empty response body)

Authorization

JWT, apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VMMicroserviceControllerPowerStatusVMInstance

VMMicroserviceControllerPowerStatusVMInstance(ctx, vmId) Retrieves the power status of the VM

Retrieves the power status of the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmId float64

Return type

(empty response body)

Authorization

JWT, apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VMMicroserviceControllerRebootVM

VMMicroserviceControllerRebootVM(ctx, vmId) Reboots the VM

Reboots the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmId float64

Return type

(empty response body)

Authorization

JWT, apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VMMicroserviceControllerShutdownVM

VMMicroserviceControllerShutdownVM(ctx, vmId) Shuts down the VM

Shuts down the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmId float64

Return type

(empty response body)

Authorization

JWT, apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

VMMicroserviceControllerStartVM

VMMicroserviceControllerStartVM(ctx, vmId) Starts the VM

Starts the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmId float64

Return type

(empty response body)

Authorization

JWT, apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]