github.com/ionos-cloud/sdk-go-vpn

Go API client for ionoscloud

POC Docs for VPN gateway as service

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.0.1
• Package version: v1.0.1
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://docs.ionos.com/support/general-information/contact-information

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 ionoscloud "github.com/ionos-cloud/sdk-go-vpn"

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

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to https://vpn.de-fra.ionos.com

Class	Method	HTTP request	Description
IPSecGatewaysApi	IpsecgatewaysDelete	Delete /ipsecgateways/{gatewayId}	Delete IPSecGateway
IPSecGatewaysApi	IpsecgatewaysFindById	Get /ipsecgateways/{gatewayId}	Retrieve IPSecGateway
IPSecGatewaysApi	IpsecgatewaysGet	Get /ipsecgateways	Retrieve all IPSecGateways
IPSecGatewaysApi	IpsecgatewaysPost	Post /ipsecgateways	Create IPSecGateway
IPSecGatewaysApi	IpsecgatewaysPut	Put /ipsecgateways/{gatewayId}	Ensure IPSecGateway
IPSecTunnelsApi	IpsecgatewaysTunnelsDelete	Delete /ipsecgateways/{gatewayId}/tunnels/{tunnelId}	Delete IPSecTunnel
IPSecTunnelsApi	IpsecgatewaysTunnelsFindById	Get /ipsecgateways/{gatewayId}/tunnels/{tunnelId}	Retrieve IPSecTunnel
IPSecTunnelsApi	IpsecgatewaysTunnelsGet	Get /ipsecgateways/{gatewayId}/tunnels	Retrieve all IPSecTunnels
IPSecTunnelsApi	IpsecgatewaysTunnelsPost	Post /ipsecgateways/{gatewayId}/tunnels	Create IPSecTunnel
IPSecTunnelsApi	IpsecgatewaysTunnelsPut	Put /ipsecgateways/{gatewayId}/tunnels/{tunnelId}	Ensure IPSecTunnel
WireguardGatewaysApi	WireguardgatewaysDelete	Delete /wireguardgateways/{gatewayId}	Delete WireguardGateway
WireguardGatewaysApi	WireguardgatewaysFindById	Get /wireguardgateways/{gatewayId}	Retrieve WireguardGateway
WireguardGatewaysApi	WireguardgatewaysGet	Get /wireguardgateways	Retrieve all WireguardGateways
WireguardGatewaysApi	WireguardgatewaysPost	Post /wireguardgateways	Create WireguardGateway
WireguardGatewaysApi	WireguardgatewaysPut	Put /wireguardgateways/{gatewayId}	Ensure WireguardGateway
WireguardPeersApi	WireguardgatewaysPeersDelete	Delete /wireguardgateways/{gatewayId}/peers/{peerId}	Delete WireguardPeer
WireguardPeersApi	WireguardgatewaysPeersFindById	Get /wireguardgateways/{gatewayId}/peers/{peerId}	Retrieve WireguardPeer
WireguardPeersApi	WireguardgatewaysPeersGet	Get /wireguardgateways/{gatewayId}/peers	Retrieve all WireguardPeers
WireguardPeersApi	WireguardgatewaysPeersPost	Post /wireguardgateways/{gatewayId}/peers	Create WireguardPeer
WireguardPeersApi	WireguardgatewaysPeersPut	Put /wireguardgateways/{gatewayId}/peers/{peerId}	Ensure WireguardPeer

Documentation For Models

• Connection
• ESPEncryption
• Error
• ErrorMessages
• IKEEncryption
• IPSecGateway
• IPSecGatewayCreate
• IPSecGatewayEnsure
• IPSecGatewayMetadata
• IPSecGatewayRead
• IPSecGatewayReadList
• IPSecGatewayReadListAllOf
• IPSecPSK
• IPSecTunnel
• IPSecTunnelAuth
• IPSecTunnelCreate
• IPSecTunnelEnsure
• IPSecTunnelMetadata
• IPSecTunnelRead
• IPSecTunnelReadList
• IPSecTunnelReadListAllOf
• Links
• Metadata
• Pagination
• ResourceStatus
• WireguardEndpoint
• WireguardGateway
• WireguardGatewayCreate
• WireguardGatewayEnsure
• WireguardGatewayMetadata
• WireguardGatewayMetadataAllOf
• WireguardGatewayRead
• WireguardGatewayReadList
• WireguardGatewayReadListAllOf
• WireguardPeer
• WireguardPeerCreate
• WireguardPeerEnsure
• WireguardPeerMetadata
• WireguardPeerRead
• WireguardPeerReadList
• WireguardPeerReadListAllOf

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_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

[e-mail]