Go API client for pxapiflat

ProxMox VE API

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: 8.0
• Package version: 1.0.0
• 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 pxapiflat "github.com/DirkTheDaring/px-api-client-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 pxapiflat.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), pxapiflat.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 pxapiflat.ContextOperationServerIndices and pxapiflat.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://127.0.0.1:8006/api2/json

Class	Method	HTTP request	Description
AccessAPI	CreateAccessTicket	Post /access/ticket	createAccessTicket
AccessAPI	GetAccessTicket	Get /access/ticket	getAccessTicket
ClusterAPI	GetClusterConfigNodes	Get /cluster/config/nodes	getClusterConfigNodes
ClusterAPI	GetClusterNextid	Get /cluster/nextid	getClusterNextid
ClusterAPI	GetClusterResources	Get /cluster/resources	getClusterResources
NodesAPI	CreateContainer	Post /nodes/{node}/lxc	createContainer
NodesAPI	CreateContainerSnapshot	Post /nodes/{node}/lxc/{vmid}/snapshot	createContainerSnapshot
NodesAPI	CreateNodesSingleStorageSingleContent	Post /nodes/{node}/storage/{storage}/content	createNodesSingleStorageSingleContent
NodesAPI	CreateVM	Post /nodes/{node}/qemu	createVM
NodesAPI	CreateVMSnapshot	Post /nodes/{node}/qemu/{vmid}/snapshot	createVMSnapshot
NodesAPI	DeleteContainer	Delete /nodes/{node}/lxc/{vmid}	deleteContainer
NodesAPI	DeleteContainerSnapshot	Delete /nodes/{node}/lxc/{vmid}/snapshot/{snapname}	deleteContainerSnapshot
NodesAPI	DeleteVM	Delete /nodes/{node}/qemu/{vmid}	deleteVM
NodesAPI	DeleteVMSnapshot	Delete /nodes/{node}/qemu/{vmid}/snapshot/{snapname}	deleteVMSnapshot
NodesAPI	GetContainer	Get /nodes/{node}/lxc/{vmid}	getContainer
NodesAPI	GetContainerConfig	Get /nodes/{node}/lxc/{vmid}/config	getContainerConfig
NodesAPI	GetContainerConfigPending	Get /nodes/{node}/lxc/{vmid}/pending	getContainerConfigPending
NodesAPI	GetContainerSnapshot	Get /nodes/{node}/lxc/{vmid}/snapshot/{snapname}	getContainerSnapshot
NodesAPI	GetContainerSnapshotConfig	Get /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config	getContainerSnapshotConfig
NodesAPI	GetContainerSnapshots	Get /nodes/{node}/lxc/{vmid}/snapshot	getContainerSnapshots
NodesAPI	GetContainerStatus	Get /nodes/{node}/lxc/{vmid}/status	getContainerStatus
NodesAPI	GetContainers	Get /nodes/{node}/lxc	getContainers
NodesAPI	GetCurrentContainerStatus	Get /nodes/{node}/lxc/{vmid}/status/current	getCurrentContainerStatus
NodesAPI	GetCurrentVMStatus	Get /nodes/{node}/qemu/{vmid}/status/current	getCurrentVMStatus
NodesAPI	GetNodeTask	Get /nodes/{node}/tasks/{upid}	getNodeTask
NodesAPI	GetNodeTaskLog	Get /nodes/{node}/tasks/{upid}/log	getNodeTaskLog
NodesAPI	GetNodeTaskStatus	Get /nodes/{node}/tasks/{upid}/status	getNodeTaskStatus
NodesAPI	GetNodeTasks	Get /nodes/{node}/tasks	getNodeTasks
NodesAPI	GetStorageContent	Get /nodes/{node}/storage/{storage}/content	getStorageContent
NodesAPI	GetStorages	Get /nodes/{node}/storage	getStorages
NodesAPI	GetVM	Get /nodes/{node}/qemu/{vmid}	getVM
NodesAPI	GetVMConfig	Get /nodes/{node}/qemu/{vmid}/config	getVMConfig
NodesAPI	GetVMConfigPending	Get /nodes/{node}/qemu/{vmid}/pending	getVMConfigPending
NodesAPI	GetVMSnapshot	Get /nodes/{node}/qemu/{vmid}/snapshot/{snapname}	getVMSnapshot
NodesAPI	GetVMSnapshotConfig	Get /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config	getVMSnapshotConfig
NodesAPI	GetVMSnapshots	Get /nodes/{node}/qemu/{vmid}/snapshot	getVMSnapshots
NodesAPI	GetVMs	Get /nodes/{node}/qemu	getVMs
NodesAPI	RebootContainer	Post /nodes/{node}/lxc/{vmid}/status/reboot	rebootContainer
NodesAPI	RebootVM	Post /nodes/{node}/qemu/{vmid}/status/reboot	rebootVM
NodesAPI	ResizeContainerDisk	Put /nodes/{node}/lxc/{vmid}/resize	resizeContainerDisk
NodesAPI	ResizeVMDisk	Put /nodes/{node}/qemu/{vmid}/resize	resizeVMDisk
NodesAPI	ResumeContainer	Post /nodes/{node}/lxc/{vmid}/status/resume	resumeContainer
NodesAPI	ResumeVM	Post /nodes/{node}/qemu/{vmid}/status/resume	resumeVM
NodesAPI	RollbackContainerSnapshot	Post /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback	rollbackContainerSnapshot
NodesAPI	RollbackVMSnapshot	Post /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback	rollbackVMSnapshot
NodesAPI	ShutdownContainer	Post /nodes/{node}/lxc/{vmid}/status/shutdown	shutdownContainer
NodesAPI	ShutdownVM	Post /nodes/{node}/qemu/{vmid}/status/shutdown	shutdownVM
NodesAPI	StartContainer	Post /nodes/{node}/lxc/{vmid}/status/start	startContainer
NodesAPI	StartVM	Post /nodes/{node}/qemu/{vmid}/status/start	startVM
NodesAPI	StopContainer	Post /nodes/{node}/lxc/{vmid}/status/stop	stopContainer
NodesAPI	StopNodeTask	Delete /nodes/{node}/tasks/{upid}	stopNodeTask
NodesAPI	StopVM	Post /nodes/{node}/qemu/{vmid}/status/stop	stopVM
NodesAPI	SuspendContainer	Post /nodes/{node}/lxc/{vmid}/status/suspend	suspendContainer
NodesAPI	SuspendVM	Post /nodes/{node}/qemu/{vmid}/status/suspend	suspendVM
NodesAPI	UpdateContainerConfigSync	Put /nodes/{node}/lxc/{vmid}/config	updateContainerConfigSync
NodesAPI	UpdateContainerSnapshotConfig	Put /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config	updateContainerSnapshotConfig
NodesAPI	UpdateVMConfig	Post /nodes/{node}/qemu/{vmid}/config	updateVMConfig
NodesAPI	UpdateVMConfigSync	Put /nodes/{node}/qemu/{vmid}/config	updateVMConfigSync
NodesAPI	UpdateVMSnapshotConfig	Put /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config	updateVMSnapshotConfig
NodesAPI	UploadFile	Post /nodes/{node}/storage/{storage}/upload	uploadFile
StorageAPI	CreateStorage	Post /storage	createStorage
StorageAPI	GetStorage	Get /storage	getStorage

Documentation For Models

• CreateAccessTicket200Response
• CreateAccessTicket200ResponseData
• CreateAccessTicketRequest
• CreateContainerRequest
• CreateContainerSnapshotRequest
• CreateNodesSingleStorageSingleContent200Response
• CreateNodesSingleStorageSingleContentRequest
• CreateStorage200Response
• CreateStorage200ResponseData
• CreateStorage200ResponseDataConfig
• CreateStorageRequest
• CreateVM200Response
• CreateVMRequest
• CreateVMSnapshotRequest
• GetClusterConfigNodes200Response
• GetClusterConfigNodes200ResponseDataInner
• GetClusterNextid200Response
• GetClusterResources200Response
• GetClusterResources200ResponseDataInner
• GetContainerConfig200Response
• GetContainerConfig200ResponseData
• GetContainerConfigPending200Response
• GetContainerConfigPending200ResponseDataInner
• GetContainerSnapshots200Response
• GetContainerSnapshots200ResponseDataInner
• GetContainers200Response
• GetContainers200ResponseDataInner
• GetCurrentContainerStatus200Response
• GetCurrentContainerStatus200ResponseData
• GetCurrentVMStatus200Response
• GetCurrentVMStatus200ResponseData
• GetNodeTaskLog200Response
• GetNodeTaskLog200ResponseDataInner
• GetNodeTaskStatus200Response
• GetNodeTaskStatus200ResponseData
• GetNodeTasks200Response
• GetNodeTasks200ResponseDataInner
• GetStorage200Response
• GetStorage200ResponseDataInner
• GetStorageContent200Response
• GetStorageContent200ResponseDataInner
• GetStorageContent200ResponseDataInnerVerification
• GetStorages200Response
• GetStorages200ResponseDataInner
• GetVM200Response
• GetVM200ResponseDataInner
• GetVMConfig200Response
• GetVMConfig200ResponseData
• GetVMConfigPending200Response
• GetVMConfigPending200ResponseDataInner
• GetVMConfigPending200ResponseDataInnerOneOf
• GetVMConfigPending200ResponseDataInnerOneOf1
• GetVMSnapshot200Response
• GetVMSnapshotConfig200Response
• GetVMSnapshots200Response
• GetVMSnapshots200ResponseDataInner
• GetVMs200Response
• GetVMs200ResponseDataInner
• RebootContainerRequest
• RebootVMRequest
• ResizeContainerDiskRequest
• ResizeVMDiskRequest
• ResumeVMRequest
• RollbackContainerSnapshotRequest
• RollbackVMSnapshotRequest
• ShutdownContainerRequest
• ShutdownVMRequest
• StartContainerRequest
• StartVMRequest
• StopContainerRequest
• StopVMRequest
• SuspendVMRequest
• TaskStartResponse
• UpdateContainerConfigSyncRequest
• UpdateContainerSnapshotConfigRequest
• UpdateVMConfigRequest
• UpdateVMConfigSyncRequest
• UpdateVMSnapshotConfigRequest

Documentation For Authorization

Authentication schemes defined for the API:

cookie

• Type: API key
• API key parameter name: Cookie
• Location: HTTP header

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

Example

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

token

• Type: API key
• API key parameter name: CSRFPreventionToken
• Location: HTTP header

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

Example

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

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[email protected]