github.com/metalsoft-io/metal-cloud-sdk2-go
MetalSoft REST API documentation
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.
Put the package under your project folder and add the following in import:
import "./sdk2"
All URIs are relative to **
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AIApi | GenerateEliResponse | Post /api/v2/ai/generate | Request from AI a response for the given input |
| AccountsApi | ArchiveAccount | Post /api/v2/accounts/{accountId}/actions/archive | Archive account |
| AccountsApi | CreateAccount | Post /api/v2/accounts | Create account |
| AccountsApi | GetAccount | Get /api/v2/accounts/{accountId} | Get account by id |
| AccountsApi | GetAccountLimits | Get /api/v2/accounts/{accountId}/limits | Get account limits |
| AccountsApi | GetAccountUsers | Get /api/v2/accounts/{accountId}/users | Get users for account |
| AccountsApi | GetAccounts | Get /api/v2/accounts | Get all accounts |
| AccountsApi | UnarchiveAccount | Post /api/v2/accounts/{accountId}/actions/unarchive | Unarchive account |
| AccountsApi | UpdateAccount | Patch /api/v2/accounts/{accountId} | Update account |
| AccountsApi | UpdateAccountLimits | Patch /api/v2/accounts/{accountId}/limits | Update account limits |
| BucketApi | CreateInfrastructureBucket | Post /api/v2/infrastructures/{infrastructureId}/buckets | Creates a Bucket |
| BucketApi | DeleteBucket | Delete /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId} | Deletes a Bucket |
| BucketApi | GetBucket | Get /api/v2/buckets/{bucketId} | Get Bucket information |
| BucketApi | GetInfrastructureBucket | Get /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId} | Get Bucket information |
| BucketApi | GetInfrastructureBuckets | Get /api/v2/infrastructures/{infrastructureId}/buckets | Get all Buckets |
| BucketApi | StartBucket | Post /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}/actions/start | Starts a Bucket |
| BucketApi | StopBucket | Post /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId}/actions/stop | Stops a Bucket |
| BucketApi | UpdateBucket | Patch /api/v2/infrastructures/{infrastructureId}/buckets/{bucketId} | Updates Bucket information |
| ConfigurationApi | GetConfiguration | Get /api/v2/config | Get configuration |
| ExtensionApi | ArchiveExtension | Post /api/v2/extensions/{extensionId}/actions/archive | Archive published extension |
| ExtensionApi | CreateExtension | Post /api/v2/extensions | Create extension |
| ExtensionApi | GetExtension | Get /api/v2/extensions/{extensionId} | Get details for an extension |
| ExtensionApi | GetExtensionDefinition | Get /api/v2/extensions/{extensionId}/definition | Get definition for an extension |
| ExtensionApi | GetExtensions | Get /api/v2/extensions | List available extensions |
| ExtensionApi | PublishExtension | Post /api/v2/extensions/{extensionId}/actions/publish | Publish draft extension |
| ExtensionApi | UpdateExtension | Patch /api/v2/extensions/{extensionId} | Update extension |
| ExtensionInstanceApi | CreateExtensionInstance | Post /api/v2/infrastructures/{infrastructureId}/extension-instances | Add extension instance to an infrastructure |
| ExtensionInstanceApi | DeleteExtensionInstance | Delete /api/v2/extension-instances/{extensionInstanceId} | Delete extension instance |
| ExtensionInstanceApi | GetExtensionInstance | Get /api/v2/extension-instances/{extensionInstanceId} | Get extension instance details |
| ExtensionInstanceApi | GetExtensionInstances | Get /api/v2/extension-instances | Get extension instances list |
| ExtensionInstanceApi | UpdateExtensionInstance | Patch /api/v2/extension-instances/{extensionInstanceId} | Update extension instance configuration |
| FileShareApi | CreateInfrastructureFileShare | Post /api/v2/infrastructures/{infrastructureId}/file-shares | Creates a File Share |
| FileShareApi | DeleteFileShare | Delete /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId} | Deletes a File Share |
| FileShareApi | GetFileShare | Get /api/v2/file-shares/{fileShareId} | Get File Share information |
| FileShareApi | GetFileShareHosts | Get /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/hosts | Get the Hosts of File Share |
| FileShareApi | GetInfrastructureFileShare | Get /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId} | Get File Share information |
| FileShareApi | GetInfrastructureFileShares | Get /api/v2/infrastructures/{infrastructureId}/file-shares | Get all File Shares |
| FileShareApi | StartFileShare | Post /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/actions/start | Starts a File Share |
| FileShareApi | StopFileShare | Post /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/actions/stop | Stops a File Share |
| FileShareApi | UpdateFileShare | Patch /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId} | Updates File Share information |
| FileShareApi | UpdateFileShareInstanceArrayHostsBulk | Post /api/v2/infrastructures/{infrastructureId}/file-shares/{fileShareId}/actions/modify-instance-array-hosts-bulk | Updates Instance Array Hosts on the File Share |
| InfrastructureApi | DeployInfrastructure | Post /api/v2/infrastructures/{infrastructureId}/actions/deploy | Deploys the specified infrastructure |
| InfrastructureApi | GetInfrastructure | Get /api/v2/infrastructures/{infrastructureId} | Retrieves the specified infrastructure |
| InfrastructureApi | GetInfrastructures | Get /api/v2/infrastructures | Get all infrastructures |
| InfrastructureApi | RevertInfrastructure | Post /api/v2/infrastructures/{infrastructureId}/actions/revert | Reverts the specified infrastructure |
| NetworkApi | CreateInfrastructureNetwork | Post /api/v2/infrastructures/{infrastructureId}/networks | Creates a new LAN network on the infrastructure |
| NetworkApi | DeleteInfrastructureNetwork | Delete /api/v2/infrastructures/{infrastructureId}/networks/{networkId} | Deletes a network from the infrastructure |
| NetworkApi | GetInfrastructureNetwork | Get /api/v2/infrastructures/{infrastructureId}/networks/{networkId} | Gets the specified network from the infrastructure |
| NetworkApi | GetInfrastructureNetworks | Get /api/v2/infrastructures/{infrastructureId}/networks | Retrieves all networks on the infrastructure |
| NetworkDevicesApi | ChangeNetworkDeviceStatus | Patch /api/v2/network-devices/{networkDeviceId}/actions/change-status | Change status of a network device |
| NetworkDevicesApi | DiscoverNetworkDevice | Post /api/v2/network-devices/{networkDeviceId}/discover | Discover network device interfaces, hardware and software configuration |
| NetworkDevicesApi | EnableNetworkDeviceSyslog | Post /api/v2/network-devices/{networkDeviceId}/actions/syslog-subscribe | Enables remote syslog for a network device |
| NetworkDevicesApi | GetNetworkDevicePorts | Get /api/v2/network-devices/{networkDeviceId}/ports | Get all ports for network device |
| NetworkDevicesApi | ResetNetworkDevice | Post /api/v2/network-devices/{networkDeviceId}/actions/reset | Resets a network device to default state |
| NetworkDevicesApi | SetNetworkDevicePortStatus | Post /api/v2/network-devices/{networkDeviceId}/actions/set-port-status | Set port status |
| ResourcePoolsApi | AddResourcePoolUser | Post /api/v2/resource-pools/user/{userId}/pool/{resourcePoolId} | Add a user to a Resource Pool |
| ResourcePoolsApi | AddServerToResourcePool | Put /api/v2/resource-pools/{resourcePoolId}/server/{serverId} | Add a server to a Resource Pool |
| ResourcePoolsApi | AddSubnetPoolToResourcePool | Put /api/v2/resource-pools/{resourcePoolId}/subnet-pool/{subnetPoolId} | Add a subnet pool to a resource pool |
| ResourcePoolsApi | CreateResourcePool | Post /api/v2/resource-pools | Creates a Resource Pool |
| ResourcePoolsApi | DeleteResourcePool | Delete /api/v2/resource-pools/{resourcePoolId} | Deletes a Resource Pool |
| ResourcePoolsApi | GetResourcePool | Get /api/v2/resource-pools/{resourcePoolId} | Get Resource Pool information |
| ResourcePoolsApi | GetResourcePoolServers | Get /api/v2/resource-pools/{resourcePoolId}/servers | Get all servers that are part of a Resource Pool |
| ResourcePoolsApi | GetResourcePoolSubnetPools | Get /api/v2/resource-pools/{resourcePoolId}/subnet-pools | Get all subnet pools that are part of a resource pool |
| ResourcePoolsApi | GetResourcePoolUsers | Get /api/v2/resource-pools/{resourcePoolId}/users | Get all users that have access to a Resource Pool |
| ResourcePoolsApi | GetResourcePools | Get /api/v2/resource-pools | Get all Resource Pools |
| ResourcePoolsApi | GetUserResourcePools | Get /api/v2/resource-pools/user/{userId} | Get all Resource Pools that a user has access to |
| ResourcePoolsApi | RemoveResourcePoolUser | Delete /api/v2/resource-pools/user/{userId}/pool/{resourcePoolId} | Remove a user from a Resource Pool |
| ResourcePoolsApi | RemoveServerFromResourcePool | Delete /api/v2/resource-pools/{resourcePoolId}/server/{serverId} | Remove a server from a Resource Pool |
| ResourcePoolsApi | RemoveSubnetPoolFromResourcePool | Delete /api/v2/resource-pools/{resourcePoolId}/subnet-pool/{subnetPoolId} | Remove a subnet from a resource pool |
| ResourcePoolsApi | UpdateResourcePool | Put /api/v2/resource-pools/{resourcePoolId} | Updates Resource Pool information |
| SecurityApi | ListProviders | Get /api/v2/authentication/providers | Get available authentication providers |
| SecurityApi | UpdateProvider | Patch /api/v2/authentication/providers/{name} | Updates authentication provider |
| ServerApi | EnableServerSyslog | Post /api/v2/servers/{serverId}/actions/syslog-subscribe | Enables remote syslog for a server |
| ServerApi | GetServerInfo | Get /api/v2/servers/{serverId} | Get Server information |
| ServerApi | GetServerPowerState | Post /api/v2/servers/{serverId}/actions/get-power | Gets the power state of a server |
| ServerApi | GetServerRemoteConsoleInfo | Get /api/v2/servers/{serverId}/remote-console-info | Get Remote Console information |
| ServerApi | GetServerVNCInfo | Get /api/v2/servers/{serverId}/vnc-info | Get VNC information |
| ServerApi | InventoryController1ReRegisterServer | Post /api/v2/servers/{serverId}/actions/re-register | Re-register a server |
| ServerApi | RegisterServer | Post /api/v2/servers | Initialize server registration |
| ServerApi | ResetServerToFactoryDefaults | Post /api/v2/servers/{serverId}/actions/factory-reset | Resets a server to factory defaults |
| ServerApi | SetServerPowerState | Post /api/v2/servers/{serverId}/actions/set-power | Sets the power state of a server |
| StorageApi | CreateStorage | Post /api/v2/storages | Creates a Storage |
| StorageApi | GetStorage | Get /api/v2/storages/{storageId} | Retrieves a Storage |
| StorageApi | GetStorageBuckets | Get /api/v2/storages/{storageId}/buckets | Get all Buckets linked to the specified storage |
| StorageApi | GetStorageFileShares | Get /api/v2/storages/{storageId}/file-shares | Get all File Shares linked to the specified storage |
| StorageApi | UpdateStorage | Patch /api/v2/storages/{storageId} | Updates a Storage |
| SystemApi | GetVersion | Get /api/v2/version | Get MetalSoft system version |
| UsersApi | ArchiveUser | Post /api/v2/users/{userId}/actions/archive | Archive user |
| UsersApi | ChangeUserAccount | Post /api/v2/users/{userId}/actions/change-account | Change account for user |
| UsersApi | CreateUser | Post /api/v2/users | Creates a user |
| UsersApi | GetUser | Get /api/v2/users/{userId} | Get user |
| UsersApi | GetUserLimits | Get /api/v2/users/{userId}/limits | Get user limits |
| UsersApi | GetUsers | Get /api/v2/users | Get users |
| UsersApi | UnarchiveUser | Post /api/v2/users/{userId}/actions/unarchive | Unarchive user |
| UsersApi | UpdateUser | Patch /api/v2/users/{userId} | Update user |
| UsersApi | UpdateUserLimits | Patch /api/v2/users/{userId}/limits | Update user limits |
| VMInstanceApi | ApplyVMTypeOnVMInstance | Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/actions/apply-type/{vmTypeId} | Applies a VM Type to a VM Instance |
| VMInstanceApi | CreateVMInstance | Post /api/v2/infrastructures/{infrastructureId}/vm-instances | Creates a VM Instance |
| VMInstanceApi | DeleteVMInstance | Delete /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId} | Deletes a VM Instance |
| VMInstanceApi | GetVMInstance | Get /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId} | Get VM Instance information |
| VMInstanceApi | GetVMInstancePowerStatus | Get /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/power-status | Retrieves the power status of the VM Instance |
| VMInstanceApi | RebootVMInstance | Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/reboot | Reboots the VM Instance |
| VMInstanceApi | ShutdownVMInstance | Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/shutdown | Shuts down the VM Instance |
| VMInstanceApi | StartVMInstance | Post /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId}/start | Starts the VM Instance |
| VMInstanceApi | UpdateVMInstance | Patch /api/v2/infrastructures/{infrastructureId}/vm-instances/{vmInstanceId} | Updates VM Instance information |
| VMInstanceGroupApi | ApplyVMTypeOnVMInstanceGroup | Post /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/actions/apply-type/{vmTypeId} | Applies a VM Type to a VM Instance Group |
| VMInstanceGroupApi | CreateVMInstanceGroup | Post /api/v2/infrastructures/{infrastructureId}/vm-instance-groups | Creates a VM Instance Group |
| VMInstanceGroupApi | CreateVMInterfaceOnVMInstanceGroup | Post /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/interfaces | Creates a new Virtual Interface for the VM Instance Group |
| VMInstanceGroupApi | DeleteVMInstanceGroup | Delete /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId} | Deletes a VM Instance Group |
| VMInstanceGroupApi | GetVMInstanceGroup | Get /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId} | Get VM Instance Group information |
| VMInstanceGroupApi | GetVMInstanceGroupVMInstances | Get /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/vm-instances | Get the VM Instances of VM Instance Group |
| VMInstanceGroupApi | GetVMInstanceGroups | Get /api/v2/infrastructures/{infrastructureId}/vm-instance-groups | Get all VM Instance Groups |
| VMInstanceGroupApi | UpdateNetworkProfileOnVMInstanceGroupNetwork | Patch /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId}/network/{networkId} | Applies the given Network Profile to the specified VM Instance Group Network |
| VMInstanceGroupApi | UpdateVMInstanceGroup | Patch /api/v2/infrastructures/{infrastructureId}/vm-instance-groups/{vmInstanceGroupId} | Updates VM Instance Group information |
| VMPoolsApi | CreateVMPool | Post /api/v2/vm-pools | Creates a VM Pool |
| VMPoolsApi | DeleteVMPool | Delete /api/v2/vm-pools/{vmPoolId} | Deletes a VM Pool |
| VMPoolsApi | GetVMPool | Get /api/v2/vm-pools/{vmPoolId} | Get VM Pool information |
| VMPoolsApi | GetVMPoolClusterHost | Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId} | Retrieves a VM Cluster Host |
| VMPoolsApi | GetVMPoolClusterHostInterface | Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/interfaces/{vmPoolClusterHostInterfaceId} | Retrieves a VM Cluster Host Interface |
| VMPoolsApi | GetVMPoolClusterHostInterfaces | Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/interfaces | Retrieves a list of VM Cluster Host Interfaces |
| VMPoolsApi | GetVMPoolClusterHostVMs | Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/vms | Retrieves a list of VM Cluster Host VMs |
| VMPoolsApi | GetVMPoolClusterHosts | Get /api/v2/vm-pools/{vmPoolId}/cluster-hosts | Get list of VM Cluster Hosts linked to the VM Pool |
| VMPoolsApi | GetVMPoolVMs | Get /api/v2/vm-pools/{vmPoolId}/vms | Returns all VMs linked to the VM Pool |
| VMPoolsApi | GetVMPools | Get /api/v2/vm-pools | Get all VM Pools |
| VMPoolsApi | UpdateVMPool | Patch /api/v2/vm-pools/{vmPoolId} | Updates VM Pool information |
| VMPoolsApi | UpdateVMPoolClusterHostInterface | Patch /api/v2/vm-pools/{vmPoolId}/cluster-hosts/{vmPoolClusterHostId}/interfaces/{vmPoolClusterHostInterfaceId} | Updates a VM Cluster Host Interface |
| VMTypesApi | CreateVMType | Post /api/v2/vm-types | Creates a VM Type |
| VMTypesApi | DeleteVMType | Delete /api/v2/vm-types/{vmTypeId} | Deletes a VM Type |
| VMTypesApi | GetVMType | Get /api/v2/vm-types/{vmTypeId} | Get VM Type information |
| VMTypesApi | GetVMTypes | Get /api/v2/vm-types | Get all VM Types |
| VMTypesApi | GetVMsByVMType | Get /api/v2/vm-types/{vmTypeId}/vms | Returns all VMs linked to the VM Type |
| VMTypesApi | UpdateVMType | Patch /api/v2/vm-types/{vmTypeId} | Updates VM Type information |
| VMsApi | GetVM | Get /api/v2/vms/{vmId} | Retrieves the VM information |
| VMsApi | GetVMPowerStatus | Get /api/v2/vms/{vmId}/power-status | Retrieves the power status of the VM |
| VMsApi | GetVMRemoteConsoleInfo | Get /api/v2/vms/{vmId}/remote-console-info | Get Remote Console information |
| VMsApi | RebootVM | Post /api/v2/vms/{vmId}/reboot | Reboots the VM |
| VMsApi | ShutdownVM | Post /api/v2/vms/{vmId}/shutdown | Shuts down the VM |
| VMsApi | StartVM | Post /api/v2/vms/{vmId}/start | Starts the VM |
| VMsApi | UpdateVM | Patch /api/v2/vms/{vmId} | Updates VM information |
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Company News
Socket safeguards companies from software supply chain attacks by detecting and preventing threats in open source code and empowering developers to secure their applications and critical services against malware and other security risks.
Product
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!