The Managed VPN Gateway service provides secure and scalable connectivity, enabling encrypted communication between your IONOS cloud resources in a VDC and remote networks (on-premises, multi-cloud, private LANs in other VDCs etc).
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.0
- Package version: 1.0.2
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://docs.ionos.com/support/general-information/contact-information
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
Put the package under your project folder and add the following in import:
import "./ionoscloud"
All available server URLs are:
- https://vpn.de-fra.ionos.com - Production de-fra
- https://vpn.de-txl.ionos.com - Production de-txl
- https://vpn.es-vit.ionos.com - Production es-vit
- https://vpn.gb-bhx.ionos.com - Production gb-bhx
- https://vpn.gb-lhr.ionos.com - Production gb-lhr
- https://vpn.us-ewr.ionos.com - Production us-ewr
- https://vpn.us-las.ionos.com - Production us-las
- https://vpn.us-mci.ionos.com - Production us-mci
- https://vpn.fr-par.ionos.com - Production fr-par
By default, https://vpn.de-fra.ionos.com is used, however this can be overriden at authentication, either
by setting the IONOS_API_URL
environment variable or by specifying the hostUrl
parameter when
initializing the sdk client.
The username and password or the authentication token can be manually specified when initializing the sdk client:
client := ionoscloud.NewAPIClient(ionoscloud.NewConfiguration(username, password, token, hostUrl))
Environment variables can also be used. The sdk uses the following variables:
- IONOS_TOKEN - login via token. This is the recommended way to authenticate.
- IONOS_USERNAME - to specify the username used to login
- IONOS_PASSWORD - to specify the password
- IONOS_API_URL - to specify the API server URL
In this case, the client configuration needs to be initialized using NewConfigurationFromEnv()
.
client := ionoscloud.NewAPIClient(ionoscloud.NewConfigurationFromEnv())
All URIs are relative to https://vpn.de-fra.ionos.com
API Endpoints table
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 |
All URIs are relative to https://vpn.de-fra.ionos.com
API models list
- Connection
- DayOfTheWeek
- ESPEncryption
- Error
- ErrorMessages
- IKEEncryption
- IPSecGateway
- IPSecGatewayCreate
- IPSecGatewayEnsure
- IPSecGatewayMetadata
- IPSecGatewayRead
- IPSecGatewayReadList
- IPSecGatewayReadListAllOf
- IPSecPSK
- IPSecTunnel
- IPSecTunnelAuth
- IPSecTunnelCreate
- IPSecTunnelEnsure
- IPSecTunnelMetadata
- IPSecTunnelRead
- IPSecTunnelReadList
- IPSecTunnelReadListAllOf
- Links
- MaintenanceWindow
- Metadata
- Pagination
- ResourceStatus
- WireguardEndpoint
- WireguardGateway
- WireguardGatewayCreate
- WireguardGatewayEnsure
- WireguardGatewayMetadata
- WireguardGatewayMetadataAllOf
- WireguardGatewayRead
- WireguardGatewayReadList
- WireguardGatewayReadListAllOf
- WireguardPeer
- WireguardPeerCreate
- WireguardPeerEnsure
- WireguardPeerMetadata
- WireguardPeerRead
- WireguardPeerReadList
- WireguardPeerReadListAllOf