Go API client for hyperstack

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

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

API version: 1.0
Package version: 1.0.0
Generator version: 7.7.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

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

import hyperstack "github.com/szczad/hyperstack-api-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value hyperstack.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), hyperstack.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value hyperstack.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), hyperstack.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using hyperstack.ContextOperationServerIndices and hyperstack.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), hyperstack.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), hyperstack.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Class	Method	HTTP request	Description
AliveAPI	GetAlive	Get /billing/alive	GET: Alive
ApiKeyAPI	DeleteAPIKey	Delete /api-key/{api_key_id}	Delete API Key
ApiKeyAPI	GenerateAPIKey	Post /api-key/generate	Generate API Key
ApiKeyAPI	RetrieveAPIKey	Get /api-key	Retrieve API Keys
ApiKeyAPI	UpdateAPIKey	Put /api-key/{api_key_id}	Update API Key
AssigningMemberRoleAPI	AssignRBACRoleToUser	Put /auth/users/{user_id}/assign-roles	Assign RBAC Role
AssigningMemberRoleAPI	RemoveRBACRoleFromUser	Delete /auth/users/{user_id}/roles	Remove RBAC Role From User
AuthAPI	RetrieveAuthenticatedUserDetails	Get /auth/me	Retrieve Authenticated User Details
BillingAPI	GetLastDayCost	Get /billing/billing/last-day-cost	GET: Last Day Cost
BillingAPI	GetUsage	Get /billing/billing/usage	GET: Billing usage
CalculateAPI	GetCalculate	Get /pricebook/calculate/resource/{resource_type}/{id}	Retrieve Billing Rate for Resource
CallbacksAPI	AttachCallbackToVirtualMachine	Post /core/virtual-machines/{id}/attach-callback	Attach callback to virtual machine
CallbacksAPI	AttachCallbackToVolume	Post /core/volumes/{id}/attach-callback	Attach callback to volume
CallbacksAPI	DeleteVirtualMachineCallback	Delete /core/virtual-machines/{id}/delete-callback	Delete virtual machine callback
CallbacksAPI	DeleteVolumeCallback	Delete /core/volumes/{id}/delete-callback	Delete volume callback
CallbacksAPI	UpdateVirtualMachineCallback	Put /core/virtual-machines/{id}/update-callback	Update virtual machine callback
CallbacksAPI	UpdateVolumeCallback	Put /core/volumes/{id}/update-callback	Update volume callback
ComplianceAPI	CreateCompliance	Post /core/compliance	Create compliance
ComplianceAPI	DeleteACompliance	Delete /core/compliance/{gpu_model}	Delete a compliance
ComplianceAPI	RetrieveCompliance	Get /core/compliance	Retrieve GPU compliance
ComplianceAPI	UpdateACompliance	Put /core/compliance	Update a compliance
CreditAPI	CheckBalanceAsAnOrganization	Get /billing/user-credit/credit	GET: View credit and threshold
CustomerContractAPI	DetailsOfContractByIDForCustomer	Get /pricebook/contracts/{contract_id}	Retrieve Contract Details
CustomerContractAPI	GetCustomerContract	Get /pricebook/contracts	List Contracts
DashboardAPI	RetrieveDashboard	Get /core/dashboard	Retrieve Dashboard
DeploymentAPI	DeleteDeployment	Delete /core/marketplace/deployments/{id}	Delete Deployment
DeploymentAPI	DetailsOfDeploymentByID	Get /core/marketplace/deployments/{id}	Details of Deployment by ID
DeploymentAPI	ListDeployments	Get /core/marketplace/deployments	List Deployments
DeploymentAPI	StartDeployment	Post /core/marketplace/deployments	Start Deployment
EnvironmentAPI	CreateEnvironment	Post /core/environments	Create environment
EnvironmentAPI	DeleteEnvironment	Delete /core/environments/{id}	Delete environment
EnvironmentAPI	ListEnvironments	Get /core/environments	List environments
EnvironmentAPI	RetrieveEnvironment	Get /core/environments/{id}	Retrieve environment
EnvironmentAPI	UpdateEnvironment	Put /core/environments/{id}	Update environment
FirewallAttachmentAPI	AttachFirewallToVMs	Post /core/firewalls/{firewall_id}/update-attachments	Attach Firewalls to VMs
FirewallsAPI	AddRulesToFirewall	Post /core/firewalls/{firewall_id}/firewall-rules	Add Rules to Firewall
FirewallsAPI	CreateFirewall	Post /core/firewalls	Create Firewall
FirewallsAPI	DeleteFirewall	Delete /core/firewalls/{id}	Delete Firewall
FirewallsAPI	DeleteFirewallRulesFromFirewall	Delete /core/firewalls/{firewall_id}/firewall-rules/{firewall_rule_id}	Delete Firewall Rules from Firewall
FirewallsAPI	DetailsOfFirewallByID	Get /core/firewalls/{id}	Details of Firewall by ID
FirewallsAPI	RetrieveFirewalls	Get /core/firewalls	List firewalls
FlavorAPI	ListFlavors	Get /core/flavors	List flavors
FloatingIpAPI	AttachPublicIPToVirtualMachine	Post /core/virtual-machines/{id}/attach-floatingip	Attach public IP to virtual machine
FloatingIpAPI	DetachPublicIPFromVirtualMachine	Post /core/virtual-machines/{id}/detach-floatingip	Detach public IP from virtual machine
GpuAPI	ListGPUs	Get /core/gpus	List GPUs
ImageAPI	ListImages	Get /core/images	List images
InviteAPI	DeleteInvite	Delete /auth/invites/{id}	Delete Invite
InviteAPI	InviteUserToOrganization	Post /auth/invites	Invite User to Organization
InviteAPI	ListInvites	Get /auth/invites	List Invites
KeypairAPI	DeleteKeyPair	Delete /core/keypair/{id}	Delete key pair
KeypairAPI	ImportKeyPair	Post /core/keypairs	Import key pair
KeypairAPI	ListKeyPairs	Get /core/keypairs	List key pairs
KeypairAPI	UpdateKeyPairName	Put /core/keypair/{id}	Update key pair name
OrganizationAPI	RemoveOrganizationMember	Post /auth/organizations/remove-member	Remove Organization Member
OrganizationAPI	RetrieveOrganizationInformation	Get /auth/organizations	Retrieve Organization Information
OrganizationAPI	UpdateOrganizationInformation	Put /auth/organizations/update	Update Organization Information
PaymentAPI	GetDetails	Get /billing/payment/payment-details	GET: View payment details
PaymentAPI	PostPayment	Post /billing/payment/payment-initiate	POST: Initiate payment
PermissionAPI	ListPermissions	Get /auth/permissions	List Permissions
PolicyAPI	ListPolicies	Get /auth/policies	List Policies
PricebookAPI	RetrivePricebook	Get /pricebook
ProfileAPI	CreateProfile	Post /core/profiles	Create profile
ProfileAPI	DeleteProfile	Delete /core/profiles/{id}	Delete profile
ProfileAPI	ListProfiles	Get /core/profiles	List profiles
ProfileAPI	RetrieveProfileDetails	Get /core/profiles/{id}	Retrieve profile details
RbacRoleAPI	CreateRBACRole	Post /auth/roles	Create RBAC Role
RbacRoleAPI	DeleteRBACRole	Delete /auth/roles/{id}	Delete RBAC Role
RbacRoleAPI	ListRBACRoles	Get /auth/roles	List RBAC Roles
RbacRoleAPI	RetrieveRBACRoleDetails	Get /auth/roles/{id}	Retrieve RBAC Role Details
RbacRoleAPI	UpdateRBACRole	Put /auth/roles/{id}	Update RBAC Role
RegionAPI	ListRegions	Get /core/regions	List regions
SecurityRulesAPI	ListFirewallRuleProtocols	Get /core/sg-rules-protocols	List firewall rule protocols
StockAPI	RetrieveGPUStocks	Get /core/stocks	Retrieve GPU stocks
TemplateAPI	CreateTemplate	Post /core/marketplace/templates	Create template
TemplateAPI	DeleteTemplate	Delete /core/marketplace/templates/{id}	Delete template
TemplateAPI	ListTemplates	Get /core/marketplace/templates	List templates
TemplateAPI	RetrieveTemplateDetails	Get /core/marketplace/templates/{id}	Retrieve template details
TemplateAPI	UpdateTemplate	Put /core/marketplace/templates/{id}	Update template
UserAPI	GetUser	Get /billing/user/info	GET: Fetch User Info
UserAPI	PostUser	Post /billing/user/info	POST: Insert user info
UserAPI	UpdateUserInfo	Put /billing/user/info	PUT: Update user info
UserDetailChoiceAPI	RetrieveDefaultFlavorsAndImages	Get /core/user/resources/defaults	Retrieve Default Flavors and Images
UserPermissionAPI	ListMyUserPermissions	Get /auth/users/me/permissions	List My User Permissions
UserPermissionAPI	ListUserPermissions	Get /auth/users/{id}/permissions	List User Permissions
VirtualMachineAPI	AddFirewallRuleToVirtualMachine	Post /core/virtual-machines/{id}/sg-rules	Add firewall rule to virtual machine
VirtualMachineAPI	AttachFirewallsToAVM	Post /core/virtual-machines/{vm_id}/attach-firewalls	Attach Firewalls to a VM
VirtualMachineAPI	CreateVirtualMachine	Post /core/virtual-machines	Create virtual machine
VirtualMachineAPI	DeleteFirewallRuleFromVirtualMachine	Delete /core/virtual-machines/{virtual_machine_id}/sg-rules/{sg_rule_id}	Delete firewall rule from virtual machine
VirtualMachineAPI	DeleteVirtualMachine	Delete /core/virtual-machines/{id}	Delete virtual machine
VirtualMachineAPI	EditLabelsOfAnExistingVM	Put /core/virtual-machines/{virtual_machine_id}/label	Edit labels of an existing VM
VirtualMachineAPI	HardRebootVirtualMachine	Get /core/virtual-machines/{id}/hard-reboot	Hard reboot virtual machine
VirtualMachineAPI	HibernateVirtualMachine	Get /core/virtual-machines/{virtual_machine_id}/hibernate	Hibernate virtual machine
VirtualMachineAPI	ListVirtualMachines	Get /core/virtual-machines	List virtual machines
VirtualMachineAPI	ResizeVirtualMachine	Post /core/virtual-machines/{virtual_machine_id}/resize	Resize virtual machine
VirtualMachineAPI	RestoreVirtualMachineFromHibernation	Get /core/virtual-machines/{virtual_machine_id}/hibernate-restore	Restore virtual machine from hibernation
VirtualMachineAPI	RetrieveVirtualMachineDetails	Get /core/virtual-machines/{id}	Retrieve virtual machine details
VirtualMachineAPI	RetrieveVirtualMachinePerformanceMetrics	Get /core/virtual-machines/{virtual_machine_id}/metrics	Retrieve virtual machine performance metrics
VirtualMachineAPI	RetrieveVirtualMachinesAssociatedWithAContract	Get /core/virtual-machines/contract/{contract_id}/virtual-machines	Retrieve virtual machines associated with a contract
VirtualMachineAPI	StartVirtualMachine	Get /core/virtual-machines/{id}/start	Start virtual machine
VirtualMachineAPI	StopVirtualMachine	Get /core/virtual-machines/{id}/stop	Stop virtual machine
VirtualMachineEventsAPI	ListVirtualMachineEvents	Get /core/virtual-machines/{virtual_machine_id}/events	List virtual machine events
VncUrlAPI	GetVNCConsoleLink	Get /core/virtual-machines/{virtual_machine_id}/console/{job_id}	Get VNC Console Link
VncUrlAPI	RequestConsole	Get /core/virtual-machines/{id}/request-console	Request Instance Console
VolumeAPI	CreateVolume	Post /core/volumes	Create volume
VolumeAPI	DeleteVolume	Delete /core/volumes/{id}	Delete volume
VolumeAPI	ListVolumeTypes	Get /core/volume-types	List volume types
VolumeAPI	ListVolumes	Get /core/volumes	List volumes
VolumeAttachmentAPI	AttachVolumesToVirtualMachine	Post /core/virtual-machines/{virtual_machine_id}/attach-volumes	Attach volumes to virtual machine
VolumeAttachmentAPI	DetachVolumesFromVirtualMachine	Post /core/virtual-machines/{virtual_machine_id}/detach-volumes	Detach volumes from virtual machine

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

accessToken

Type: API key
API key parameter name: Authorization
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		hyperstack.ContextAPIKeys,
		map[string]hyperstack.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

apiKey

Type: API key
API key parameter name: api_key
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: api_key and passed in as the auth context for each request.