Skip to content

Latest commit

 

History

History
160 lines (113 loc) · 5.28 KB

README.md

File metadata and controls

160 lines (113 loc) · 5.28 KB
Raw

Go API client for ipapi

Public IP blocks are a set of contiguous IPs that allow you to access your servers or networks from the internet. Use the IP Addresses API to request and delete IP blocks.

Knowledge base articles to help you can be found here

All URLs are relative to (https://api.phoenixnap.com/ips/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.

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 ipapi "github.com/phoenixnap/go-sdk-bmc/ipapi"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

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

Class Method HTTP request Description
IPBlocksAPI IpBlocksGet Get /ip-blocks List IP Blocks.
IPBlocksAPI IpBlocksIpBlockIdDelete Delete /ip-blocks/{ipBlockId} Delete IP Block.
IPBlocksAPI IpBlocksIpBlockIdGet Get /ip-blocks/{ipBlockId} Get IP Block.
IPBlocksAPI IpBlocksIpBlockIdPatch Patch /ip-blocks/{ipBlockId} Update IP block.
IPBlocksAPI IpBlocksIpBlockIdTagsPut Put /ip-blocks/{ipBlockId}/tags Overwrite tags assigned for IP Block.
IPBlocksAPI IpBlocksPost Post /ip-blocks Create an IP Block.

Documentation For Models

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(), ipapi.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, ipapi.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

support@phoenixnap.com