Skip to content

metalsoft-io/metal-cloud-sdk2-go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go API client for sdk2

MetalSoft REST API documentation

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.0
  • Package version: 6.4.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://www.metalsoft.io/contact

Installation

Put the package under your project folder and add the following in import:

import "./sdk2"

Documentation for API Endpoints

All URIs are relative to **

Class Method HTTP request Description
AIApi EliControllerGenerateEliResponse Post /api/v2/ai/generate Request from AI a response for the given input
AccountsApi AccountsControllerArchiveAccount Post /api/v2/accounts/{accountId}/actions/archive Archive account
AccountsApi AccountsControllerCreateAccount Post /api/v2/accounts Create account
AccountsApi AccountsControllerGetAccount Get /api/v2/accounts/{accountId} Get account by id
AccountsApi AccountsControllerGetAccountLimits Get /api/v2/accounts/{accountId}/limits Get account limits
AccountsApi AccountsControllerGetAccounts Get /api/v2/accounts Get all accounts
AccountsApi AccountsControllerGetUsersForAccount Get /api/v2/accounts/{accountId}/users Get users for account
AccountsApi AccountsControllerUnarchiveAccount Post /api/v2/accounts/{accountId}/actions/unarchive Unarchive account
AccountsApi AccountsControllerUpdateAccount Patch /api/v2/accounts/{accountId} Update account
AccountsApi AccountsControllerUpdateAccountLimits Patch /api/v2/accounts/{accountId}/limits Update account limits
BucketApi BlueprintControllerCreateBucket Post /api/v2/infrastructures/{infrastructureId}/buckets Creates a Bucket
BucketApi BlueprintControllerDeleteBucket Delete /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId} Deletes a Bucket
BucketApi BlueprintControllerGetBucket Get /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId} Get Bucket information
BucketApi BlueprintControllerGetBucketHosts Get /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}/hosts Get the Hosts of Bucket
BucketApi BlueprintControllerGetBuckets Get /api/v2/infrastructures/{infrastructureId}/buckets Get all Buckets
BucketApi BlueprintControllerGetIndividualBucket Get /api/v2/buckets/{bucketId} Get Bucket information
BucketApi BlueprintControllerStartBucket Post /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}/actions/start Starts a Bucket
BucketApi BlueprintControllerStopBucket Post /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}/actions/stop Stops a Bucket
BucketApi BlueprintControllerUpdateBucket Patch /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId} Updates Bucket information
BucketApi BlueprintControllerUpdatebucketInstanceArrayHostsBulk Post /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}/actions/modify-instance-array-hosts-bulk Updates Instance Array Hosts on the Bucket
ConfigurationApi ConfigControllerGetConfiguration Get /api/v2/config Get configuration
ExtensionApi ExtensionsControllerArchiveExtension Post /api/v2/extensions/{extensionId}/actions/archive Archive published extension
ExtensionApi ExtensionsControllerCreateExtension Post /api/v2/extensions Create extension
ExtensionApi ExtensionsControllerGetExtension Get /api/v2/extensions/{extensionId} Get details for an extension
ExtensionApi ExtensionsControllerListExtensions Get /api/v2/extensions List available extensions
ExtensionApi ExtensionsControllerPublishExtension Post /api/v2/extensions/{extensionId}/actions/publish Publish draft extension
ExtensionApi ExtensionsControllerUpdateExtension Patch /api/v2/extensions/{extensionId} Update extension
FileShareApi BlueprintControllerCreateFileShare Post /api/v2/infrastructures/{infrastructureId}/file-shares Creates a File Share
FileShareApi BlueprintControllerDeleteFileShare Delete /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId} Deletes a File Share
FileShareApi BlueprintControllerGetFileShare Get /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId} Get File Share information
FileShareApi BlueprintControllerGetFileShareHosts Get /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/hosts Get the Hosts of File Share
FileShareApi BlueprintControllerGetFileShares Get /api/v2/infrastructures/{infrastructureId}/file-shares Get all File Shares
FileShareApi BlueprintControllerGetIndividualFileShare Get /api/v2/file-shares/{fileShareId} Get File Share information
FileShareApi BlueprintControllerStartFileShare Post /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/actions/start Starts a File Share
FileShareApi BlueprintControllerStopFileShare Post /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/actions/stop Stops a File Share
FileShareApi BlueprintControllerUpdateFileShare Patch /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId} Updates File Share information
FileShareApi BlueprintControllerUpdateFileShareInstanceArrayHostsBulk Post /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/actions/modify-instance-array-hosts-bulk Updates Instance Array Hosts on the File Share
InfrastructureApi InventoryControllerDeployInfrastructure Post /api/v2/infrastructures/{infrastructureId}/actions/deploy Deploys the specified infrastructure
InfrastructureApi InventoryControllerGetInfrastructure Get /api/v2/infrastructures/{infrastructureId} Retrieves the specified infrastructure
InfrastructureApi InventoryControllerGetInfrastructures Get /api/v2/infrastructures Get all infrastructures
InfrastructureApi InventoryControllerRevertInfrastructure Post /api/v2/infrastructures/{infrastructureId}/actions/revert Reverts the specified infrastructure
NetworkApi BlueprintControllerCreateNetwork Post /api/v2/infrastructures/{infrastructureId}/networks Creates a new LAN network on the infrastructure
NetworkApi BlueprintControllerDeleteNetwork Delete /api/v2/infrastructures/{infrastructureId}/networks/{networkId} Deletes a network from the infrastructure
NetworkApi BlueprintControllerGetNetwork Get /api/v2/infrastructures/{infrastructureId}/networks/{networkId} Gets the specified network from the infrastructure
NetworkApi BlueprintControllerGetNetworks Get /api/v2/infrastructures/{infrastructureId}/networks Retrieves all networks on the infrastructure
NetworkDevicesApi SwitchControllerChangeStatus Patch /api/v2/network-devices/{networkDeviceId}/actions/change-status Change status of a network device
NetworkDevicesApi SwitchControllerDiscover Post /api/v2/network-devices/{networkDeviceId}/discover Discover network device interfaces, hardware and software configuration
NetworkDevicesApi SwitchControllerEnableSyslog Post /api/v2/network-devices/{networkDeviceId}/actions/syslog-subscribe Enables remote syslog for a network device
NetworkDevicesApi SwitchControllerGetPorts Get /api/v2/network-devices/{networkDeviceId}/ports Get all ports for network device
NetworkDevicesApi SwitchControllerResetNetworkDevice Post /api/v2/network-devices/{networkDeviceId}/actions/reset Resets a network device to default state
NetworkDevicesApi SwitchControllerSetPortStatus Post /api/v2/network-devices/{networkDeviceId}/actions/set-port-status Set port status
ResourcePoolsApi InventoryControllerAddResourcePoolUser Post /api/v2/resource-pools/user/{userId}/pool/{resourcePoolId} Add a user to a Resource Pool
ResourcePoolsApi InventoryControllerAddServerToResourcePool Put /api/v2/resource-pools/{resourcePoolId}/server/{serverId} Add a server to a Resource Pool
ResourcePoolsApi InventoryControllerAddSubnetPoolToResourcePool Put /api/v2/resource-pools/{resourcePoolId}/subnet-pool/{subnetPoolId} Add a subnet pool to a resource pool
ResourcePoolsApi InventoryControllerCreateResourcePool Post /api/v2/resource-pools Creates a Resource Pool
ResourcePoolsApi InventoryControllerDeleteResourcePool Delete /api/v2/resource-pools/{resourcePoolId} Deletes a Resource Pool
ResourcePoolsApi InventoryControllerGetResourcePool Get /api/v2/resource-pools/{resourcePoolId} Get Resource Pool information
ResourcePoolsApi InventoryControllerGetResourcePoolServers Get /api/v2/resource-pools/{resourcePoolId}/servers Get all servers that are part of a Resource Pool
ResourcePoolsApi InventoryControllerGetResourcePoolSubnetPools Get /api/v2/resource-pools/{resourcePoolId}/subnet-pools Get all subnet pools that are part of a resource pool
ResourcePoolsApi InventoryControllerGetResourcePoolUsers Get /api/v2/resource-pools/{resourcePoolId}/users Get all users that have access to a Resource Pool
ResourcePoolsApi InventoryControllerGetResourcePools Get /api/v2/resource-pools Get all Resource Pools
ResourcePoolsApi InventoryControllerGetUserResourcePools Get /api/v2/resource-pools/user/{userId} Get all Resource Pools that a user has access to
ResourcePoolsApi InventoryControllerRemoveResourcePoolUser Delete /api/v2/resource-pools/user/{userId}/pool/{resourcePoolId} Remove a user from a Resource Pool
ResourcePoolsApi InventoryControllerRemoveServerFromResourcePool Delete /api/v2/resource-pools/{resourcePoolId}/server/{serverId} Remove a server from a Resource Pool
ResourcePoolsApi InventoryControllerRemoveSubnetPoolFromResourcePool Delete /api/v2/resource-pools/{resourcePoolId}/subnet-pool/{subnetPoolId} Remove a subnet from a resource pool
ResourcePoolsApi InventoryControllerUpdateResourcePool Put /api/v2/resource-pools/{resourcePoolId} Updates Resource Pool information
SecurityApi AuthenticationControllerListProviders Get /api/v2/authentication/providers Get available authentication providers
SecurityApi AuthenticationControllerUpdateProvider Patch /api/v2/authentication/providers/{name} Updates authentication provider
ServerApi InventoryControllerGetServerInfo Get /api/v2/servers/{serverId} Get Server information
ServerApi InventoryControllerRegisterServer Post /api/v2/servers Initialize server registration
ServerApi ServersControllerEnableSyslog Post /api/v2/servers/{serverId}/actions/syslog-subscribe Enables remote syslog for a server
ServerApi ServersControllerGetPowerState Post /api/v2/servers/{serverId}/actions/get-power Gets the power state of a server
ServerApi ServersControllerGetRemoteConsoleInfo Get /api/v2/servers/{serverId}/remote-console-info Get Remote Console information
ServerApi ServersControllerGetVNCInfo Get /api/v2/servers/{serverId}/vnc-info Get VNC information
ServerApi ServersControllerResetServerToFactoryDefaults Post /api/v2/servers/{serverId}/actions/factory-reset Resets a server to factory defaults
ServerApi ServersControllerSetPowerState Post /api/v2/servers/{serverId}/actions/set-power Sets the power state of a server
StorageApi BlueprintControllerGetStorageBuckets Get /api/v2/storages/{storageId}/buckets Get all Buckets linked to the specified storage
StorageApi BlueprintControllerGetStorageFileShares Get /api/v2/storages/{storageId}/file-shares Get all File Shares linked to the specified storage
StorageApi InventoryControllerCreateStorage Post /api/v2/storages Creates a Storage
StorageApi InventoryControllerGetStorage Get /api/v2/storages/{storageId} Retrieves a Storage
StorageApi InventoryControllerPatchStorage Patch /api/v2/storages/{storageId} Updates a Storage
SystemApi SystemControllerGetVersion Get /api/v2/version Get MetalSoft system version
UsersApi UsersControllerArchiveUser Post /api/v2/users/{userId}/actions/archive Archive user
UsersApi UsersControllerChangeUserAccount Post /api/v2/users/{userId}/actions/change-account Change account for user
UsersApi UsersControllerCreateUser Post /api/v2/users Creates a user
UsersApi UsersControllerGetUser Get /api/v2/users/{userId} Get user
UsersApi UsersControllerGetUserLimits Get /api/v2/users/{userId}/limits Get user limits
UsersApi UsersControllerGetUsers Get /api/v2/users Get users
UsersApi UsersControllerUnarchiveUser Post /api/v2/users/{userId}/actions/unarchive Unarchive user
UsersApi UsersControllerUpdateUser Patch /api/v2/users/{userId} Update user
UsersApi UsersControllerUpdateUserLimits Patch /api/v2/users/{userId}/limits Update user limits
VMInstanceApi BlueprintControllerApplyVMTypeOnVMInstance Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/actions/apply-type/{vmTypeId} Applies a VM Type to a VM Instance
VMInstanceApi BlueprintControllerCreateVMInstance Post /api/v2/infrastructures/{infrastructureId}/vm-instances Creates a VM Instance
VMInstanceApi BlueprintControllerDeleteVMInstance Delete /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId} Deletes a VM Instance
VMInstanceApi BlueprintControllerGetVMInstance Get /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId} Get VM Instance information
VMInstanceApi BlueprintControllerPowerStatusVMInstance Get /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/power-status Retrieves the power status of the VM Instance
VMInstanceApi BlueprintControllerRebootVMInstance Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/reboot Reboots the VM Instance
VMInstanceApi BlueprintControllerShutdownVMInstance Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/shutdown Shuts down the VM Instance
VMInstanceApi BlueprintControllerStartVMInstance Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/start Starts the VM Instance
VMInstanceApi BlueprintControllerUpdateVMInstance Patch /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId} Updates VM Instance information
VMInstanceGroupApi BlueprintControllerApplyVMTypeOnVMInstanceGroup Post /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/actions/apply-type/{vmTypeId} Applies a VM Type to a VM Instance Group
VMInstanceGroupApi BlueprintControllerCreateVMInstanceGroup Post /api/v2/infrastructures/{infrastructureId}/vm-instance-groups Creates a VM Instance Group
VMInstanceGroupApi BlueprintControllerCreateVMInterfaceOnVMInstanceGroup Post /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/interfaces Creates a new Virtual Interface for the VM Instance Group
VMInstanceGroupApi BlueprintControllerDeleteVMInstanceGroup Delete /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId} Deletes a VM Instance Group
VMInstanceGroupApi BlueprintControllerGetVMInstanceGroup Get /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId} Get VM Instance Group information
VMInstanceGroupApi BlueprintControllerGetVMInstanceGroupVMInstances Get /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/vm-instances Get the VM Instances of VM Instance Group
VMInstanceGroupApi BlueprintControllerGetVMInstanceGroups Get /api/v2/infrastructures/{infrastructureId}/vm-instance-groups Get all VM Instance Groups
VMInstanceGroupApi BlueprintControllerPatchNetworkProfileOnVMInstanceGroupNetwork Patch /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/network/{networkId} Applies the given Network Profile to the specified VM Instance Group Network
VMInstanceGroupApi BlueprintControllerUpdateVMInstanceGroup Patch /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId} Updates VM Instance Group information
VMPoolsApi InventoryControllerCreateVMPool Post /api/v2/vm-pools Creates a VM Pool
VMPoolsApi InventoryControllerDeleteVMPool Delete /api/v2/vm-pools/{vmPoolId} Deletes a VM Pool
VMPoolsApi InventoryControllerGetVMPool Get /api/v2/vm-pools/{vmPoolId} Get VM Pool information
VMPoolsApi InventoryControllerGetVMPoolClusterHost Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId} Retrieves a VM Cluster Host
VMPoolsApi InventoryControllerGetVMPoolClusterHostInterface Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/interfaces/{vmPoolClusterHostInterfaceId} Retrieves a VM Cluster Host Interface
VMPoolsApi InventoryControllerGetVMPoolClusterHostInterfaces Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/interfaces Retrieves a list of VM Cluster Host Interfaces
VMPoolsApi InventoryControllerGetVMPoolClusterHostVMs Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/vms Retrieves a list of VM Cluster Host VMs
VMPoolsApi InventoryControllerGetVMPoolClusterHosts Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts Get list of VM Cluster Hosts linked to the VM Pool
VMPoolsApi InventoryControllerGetVMPoolVMs Get /api/v2/vm-pools/{vmPoolId}/vms Returns all VMs linked to the VM Pool
VMPoolsApi InventoryControllerGetVMPools Get /api/v2/vm-pools Get all VM Pools
VMPoolsApi InventoryControllerPatchVMPoolClusterHostInterface Patch /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/interfaces/{vmPoolClusterHostInterfaceId} Updates a VM Cluster Host Interface
VMPoolsApi InventoryControllerUpdateVMPool Patch /api/v2/vm-pools/{vmPoolId} Updates VM Pool information
VMTypesApi InventoryControllerCreateVMType Post /api/v2/vm-types Creates a VM Type
VMTypesApi InventoryControllerDeleteVMType Delete /api/v2/vm-types/{vmTypeId} Deletes a VM Type
VMTypesApi InventoryControllerGetVMType Get /api/v2/vm-types/{vmTypeId} Get VM Type information
VMTypesApi InventoryControllerGetVMTypes Get /api/v2/vm-types Get all VM Types
VMTypesApi InventoryControllerGetVMsByVMType Get /api/v2/vm-types/{vmTypeId}/vms Returns all VMs linked to the VM Type
VMTypesApi InventoryControllerUpdateVMType Patch /api/v2/vm-types/{vmTypeId} Updates VM Type information
VMsApi InventoryControllerUpdateVM Patch /api/v2/vms/{vmId} Updates VM information
VMsApi VMMicroserviceControllerGetRemoteConsoleInfo Get /api/v2/vms/{vmId}/remote-console-info Get Remote Console information
VMsApi VMMicroserviceControllerGetVM Get /api/v2/vms/{vmId} Retrieves the VM information
VMsApi VMMicroserviceControllerPowerStatusVMInstance Get /api/v2/vms/{vmId}/power-status Retrieves the power status of the VM
VMsApi VMMicroserviceControllerRebootVM Post /api/v2/vms/{vmId}/reboot Reboots the VM
VMsApi VMMicroserviceControllerShutdownVM Post /api/v2/vms/{vmId}/shutdown Shuts down the VM
VMsApi VMMicroserviceControllerStartVM Post /api/v2/vms/{vmId}/start Starts the VM

Documentation For Models

Documentation For Authorization

JWT

apiKey

Author

support@metalsoft.io