Go API client for bmcapi

Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API. Deprovision servers, get or edit SSH key details, assign public IPs, assign servers to networks and a lot more. Manage your infrastructure more efficiently using just a few simple API calls.

Knowledge base articles to help you can be found here

All URLs are relative to (https://api.phoenixnap.com/bmc/v1/)

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: 0.1 For more information, please visit https://phoenixnap.com/

Installation

Install the following dependencies:

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

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

import bmcapi "github.com/phoenixnap/go-sdk-bmc/bmcapi"

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 bmcapi.ContextServerIndex of type int.

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to https://api.phoenixnap.com/bmc/v1

Class	Method	HTTP request	Description
QuotasAPI	QuotasGet	Get /quotas	List quotas
QuotasAPI	QuotasQuotaIdActionsRequestEditPost	Post /quotas/{quotaId}/actions/request-edit	Request quota limit change.
QuotasAPI	QuotasQuotaIdGet	Get /quotas/{quotaId}	Get a quota.
SSHKeysAPI	SshKeysGet	Get /ssh-keys	List SSH Keys.
SSHKeysAPI	SshKeysPost	Post /ssh-keys	Create SSH Key.
SSHKeysAPI	SshKeysSshKeyIdDelete	Delete /ssh-keys/{sshKeyId}	Delete SSH Key.
SSHKeysAPI	SshKeysSshKeyIdGet	Get /ssh-keys/{sshKeyId}	Get SSH Key.
SSHKeysAPI	SshKeysSshKeyIdPut	Put /ssh-keys/{sshKeyId}	Edit SSH Key.
ServersAPI	DeletePrivateNetwork	Delete /servers/{serverId}/network-configuration/private-network-configuration/private-networks/{privateNetworkId}	Removes the server from private network.
ServersAPI	ServersGet	Get /servers	List servers.
ServersAPI	ServersPost	Post /servers	Create new server.
ServersAPI	ServersServerIdActionsDeprovisionPost	Post /servers/{serverId}/actions/deprovision	Deprovision a server.
ServersAPI	ServersServerIdActionsPowerOffPost	Post /servers/{serverId}/actions/power-off	Power off server.
ServersAPI	ServersServerIdActionsPowerOnPost	Post /servers/{serverId}/actions/power-on	Power on server.
ServersAPI	ServersServerIdActionsProvisionPost	Post /servers/{serverId}/actions/provision	Provision server.
ServersAPI	ServersServerIdActionsRebootPost	Post /servers/{serverId}/actions/reboot	Reboot server.
ServersAPI	ServersServerIdActionsReservePost	Post /servers/{serverId}/actions/reserve	Reserve server.
ServersAPI	ServersServerIdActionsResetPost	Post /servers/{serverId}/actions/reset	Reset server.
ServersAPI	ServersServerIdActionsShutdownPost	Post /servers/{serverId}/actions/shutdown	Shutdown server.
ServersAPI	ServersServerIdDelete	Delete /servers/{serverId}	Delete server.
ServersAPI	ServersServerIdGet	Get /servers/{serverId}	Get server.
ServersAPI	ServersServerIdIpBlocksIpBlockIdDelete	Delete /servers/{serverId}/network-configuration/ip-block-configurations/ip-blocks/{ipBlockId}	Unassign IP Block from Server.
ServersAPI	ServersServerIdIpBlocksPost	Post /servers/{serverId}/network-configuration/ip-block-configurations/ip-blocks	Assign IP Block to Server.
ServersAPI	ServersServerIdPatch	Patch /servers/{serverId}	Patch a Server.
ServersAPI	ServersServerIdPrivateNetworksPatch	Patch /servers/{serverId}/network-configuration/private-network-configuration/private-networks/{privateNetworkId}	Updates the server's private network's IP addresses
ServersAPI	ServersServerIdPrivateNetworksPost	Post /servers/{serverId}/network-configuration/private-network-configuration/private-networks	Adds the server to a private network.
ServersAPI	ServersServerIdPublicNetworksDelete	Delete /servers/{serverId}/network-configuration/public-network-configuration/public-networks/{publicNetworkId}	Removes the server from the Public Network
ServersAPI	ServersServerIdPublicNetworksPatch	Patch /servers/{serverId}/network-configuration/public-network-configuration/public-networks/{publicNetworkId}	Updates the server's public network's IP addresses.
ServersAPI	ServersServerIdPublicNetworksPost	Post /servers/{serverId}/network-configuration/public-network-configuration/public-networks	Adds the server to a Public Network.
ServersAPI	ServersServerIdTagsPut	Put /servers/{serverId}/tags	Overwrite tags assigned for Server.

Documentation For Models

• ActionResult
• DeleteResult
• DeleteSshKeyResult
• Error
• EsxiDatastoreConfiguration
• EsxiOsConfiguration
• IpBlocksConfiguration
• NetworkConfiguration
• OsConfiguration
• OsConfigurationCloudInit
• OsConfigurationMap
• OsConfigurationMapEsxi
• OsConfigurationMapProxmox
• OsConfigurationNetrisController
• OsConfigurationNetrisSoftgate
• OsConfigurationWindows
• PrivateNetworkConfiguration
• PublicNetworkConfiguration
• Quota
• QuotaEditLimitRequest
• QuotaEditLimitRequestDetails
• RelinquishIpBlock
• ResetResult
• Server
• ServerCreate
• ServerIpBlock
• ServerNetworkUpdate
• ServerPatch
• ServerPrivateNetwork
• ServerProvision
• ServerPublicNetwork
• ServerReserve
• ServerReset
• SshKey
• SshKeyCreate
• SshKeyUpdate
• StorageConfiguration
• StorageConfigurationRootPartition
• TagAssignment
• TagAssignmentRequest

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• bmc: Grants full access to bmc-api.
• bmc.read: Grants read only access to bmc-api.

Example

auth := context.WithValue(context.Background(), bmcapi.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, bmcapi.ContextOAuth2, tokenSource)
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]