Skip to content

Latest commit

 

History

History
178 lines (110 loc) · 5.6 KB

VMTypesApi.md

File metadata and controls

178 lines (110 loc) · 5.6 KB
Raw

{{classname}}

All URIs are relative to **

Method HTTP request Description
InventoryControllerCreateVMType Post /api/v2/vm-types Creates a VM Type
InventoryControllerDeleteVMType Delete /api/v2/vm-types/{vmTypeId} Deletes a VM Type
InventoryControllerGetVMType Get /api/v2/vm-types/{vmTypeId} Get VM Type information
InventoryControllerGetVMTypes Get /api/v2/vm-types Get all VM Types
InventoryControllerGetVMsByVMType Get /api/v2/vm-types/{vmTypeId}/vms Returns all VMs linked to the VM Type
InventoryControllerUpdateVMType Patch /api/v2/vm-types/{vmTypeId} Updates VM Type information

InventoryControllerCreateVMType

VmType InventoryControllerCreateVMType(ctx, body) Creates a VM Type

Creates a VM Type

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body CreateVmType The VM Type create object

Return type

VmType

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]

InventoryControllerDeleteVMType

InventoryControllerDeleteVMType(ctx, vmTypeId) Deletes a VM Type

Deletes a VM Type

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmTypeId 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]

InventoryControllerGetVMType

VmType InventoryControllerGetVMType(ctx, vmTypeId) Get VM Type information

Returns VM Type information

Required Parameters

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

Return type

VmType

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]

InventoryControllerGetVMTypes

VmTypeList InventoryControllerGetVMTypes(ctx, ) Get all VM Types

Returns list of all VM Types

Required Parameters

This endpoint does not need any parameter.

Return type

VmTypeList

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]

InventoryControllerGetVMsByVMType

InventoryControllerGetVMsByVMType(ctx, vmTypeId) Returns all VMs linked to the VM Type

Returns all VMs linked to the VM Type

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
vmTypeId 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]

InventoryControllerUpdateVMType

VmType InventoryControllerUpdateVMType(ctx, body, vmTypeId) Updates VM Type information

Updates VM Type information

Required Parameters

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

Return type

VmType

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]