modulepackage
1.0.2
Repository: https://github.com/ionos-cloud/sdk-go-vpn.git
Documentation: pkg.go.dev
# README
Go API client for ionoscloud
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).
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: 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
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
go get github.com/antihax/optional
Put the package under your project folder and add the following in import:
import "./ionoscloud"
Authentication
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())
Documentation for API Endpoints
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 |
Documentation For Models
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
# Functions
AddPinnedCert - enables pinning of the sha256 public fingerprint to the http client's transport.
CacheExpires helper function to determine remaining time before repeating a request.
IsNil checks if an input is nil.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
No description provided by the author
NewConnection instantiates a new Connection object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewConnectionWithDefaults instantiates a new Connection object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorMessages instantiates a new ErrorMessages object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorMessagesWithDefaults instantiates a new ErrorMessages object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewESPEncryption instantiates a new ESPEncryption object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewESPEncryptionWithDefaults instantiates a new ESPEncryption object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGenericOpenAPIError - constructor for GenericOpenAPIError.
NewIKEEncryption instantiates a new IKEEncryption object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIKEEncryptionWithDefaults instantiates a new IKEEncryption object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecGateway instantiates a new IPSecGateway object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecGatewayCreate instantiates a new IPSecGatewayCreate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecGatewayCreateWithDefaults instantiates a new IPSecGatewayCreate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecGatewayEnsure instantiates a new IPSecGatewayEnsure object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecGatewayEnsureWithDefaults instantiates a new IPSecGatewayEnsure object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecGatewayMetadata instantiates a new IPSecGatewayMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecGatewayMetadataWithDefaults instantiates a new IPSecGatewayMetadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecGatewayRead instantiates a new IPSecGatewayRead object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecGatewayReadList instantiates a new IPSecGatewayReadList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecGatewayReadListAllOf instantiates a new IPSecGatewayReadListAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecGatewayReadListAllOfWithDefaults instantiates a new IPSecGatewayReadListAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecGatewayReadListWithDefaults instantiates a new IPSecGatewayReadList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecGatewayReadWithDefaults instantiates a new IPSecGatewayRead object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecGatewayWithDefaults instantiates a new IPSecGateway object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecPSK instantiates a new IPSecPSK object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecPSKWithDefaults instantiates a new IPSecPSK object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecTunnel instantiates a new IPSecTunnel object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecTunnelAuth instantiates a new IPSecTunnelAuth object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecTunnelAuthWithDefaults instantiates a new IPSecTunnelAuth object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecTunnelCreate instantiates a new IPSecTunnelCreate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecTunnelCreateWithDefaults instantiates a new IPSecTunnelCreate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecTunnelEnsure instantiates a new IPSecTunnelEnsure object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecTunnelEnsureWithDefaults instantiates a new IPSecTunnelEnsure object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecTunnelMetadata instantiates a new IPSecTunnelMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecTunnelMetadataWithDefaults instantiates a new IPSecTunnelMetadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecTunnelRead instantiates a new IPSecTunnelRead object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecTunnelReadList instantiates a new IPSecTunnelReadList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecTunnelReadListAllOf instantiates a new IPSecTunnelReadListAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIPSecTunnelReadListAllOfWithDefaults instantiates a new IPSecTunnelReadListAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecTunnelReadListWithDefaults instantiates a new IPSecTunnelReadList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecTunnelReadWithDefaults instantiates a new IPSecTunnelRead object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIPSecTunnelWithDefaults instantiates a new IPSecTunnel object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewLinks instantiates a new Links object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewLinksWithDefaults instantiates a new Links object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewMaintenanceWindow instantiates a new MaintenanceWindow object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewMaintenanceWindowWithDefaults instantiates a new MaintenanceWindow object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewMetadata instantiates a new Metadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewMetadataWithDefaults instantiates a new Metadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPagination instantiates a new Pagination object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPaginationWithDefaults instantiates a new Pagination object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewResourceStatus instantiates a new ResourceStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewResourceStatusWithDefaults instantiates a new ResourceStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardEndpoint instantiates a new WireguardEndpoint object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardEndpointWithDefaults instantiates a new WireguardEndpoint object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardGateway instantiates a new WireguardGateway object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardGatewayCreate instantiates a new WireguardGatewayCreate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardGatewayCreateWithDefaults instantiates a new WireguardGatewayCreate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardGatewayEnsure instantiates a new WireguardGatewayEnsure object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardGatewayEnsureWithDefaults instantiates a new WireguardGatewayEnsure object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardGatewayMetadata instantiates a new WireguardGatewayMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardGatewayMetadataAllOf instantiates a new WireguardGatewayMetadataAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardGatewayMetadataAllOfWithDefaults instantiates a new WireguardGatewayMetadataAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardGatewayMetadataWithDefaults instantiates a new WireguardGatewayMetadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardGatewayRead instantiates a new WireguardGatewayRead object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardGatewayReadList instantiates a new WireguardGatewayReadList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardGatewayReadListAllOf instantiates a new WireguardGatewayReadListAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardGatewayReadListAllOfWithDefaults instantiates a new WireguardGatewayReadListAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardGatewayReadListWithDefaults instantiates a new WireguardGatewayReadList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardGatewayReadWithDefaults instantiates a new WireguardGatewayRead object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardGatewayWithDefaults instantiates a new WireguardGateway object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardPeer instantiates a new WireguardPeer object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardPeerCreate instantiates a new WireguardPeerCreate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardPeerCreateWithDefaults instantiates a new WireguardPeerCreate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardPeerEnsure instantiates a new WireguardPeerEnsure object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardPeerEnsureWithDefaults instantiates a new WireguardPeerEnsure object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardPeerMetadata instantiates a new WireguardPeerMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardPeerMetadataWithDefaults instantiates a new WireguardPeerMetadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardPeerRead instantiates a new WireguardPeerRead object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardPeerReadList instantiates a new WireguardPeerReadList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardPeerReadListAllOf instantiates a new WireguardPeerReadListAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewWireguardPeerReadListAllOfWithDefaults instantiates a new WireguardPeerReadListAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardPeerReadListWithDefaults instantiates a new WireguardPeerReadList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardPeerReadWithDefaults instantiates a new WireguardPeerRead object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewWireguardPeerWithDefaults instantiates a new WireguardPeer object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool - returns a pointer to given boolean value.
PtrFloat32 - returns a pointer to given float value.
PtrFloat64 - returns a pointer to given float value.
PtrInt - returns a pointer to given integer value.
PtrInt32 - returns a pointer to given integer value.
PtrInt64 - returns a pointer to given integer value.
PtrString - returns a pointer to given string value.
PtrTime - returns a pointer to given Time value.
No description provided by the author
ToBool - returns the value of the bool pointer passed in.
ToBoolDefault - returns the value of the bool pointer passed in, or false if the pointer is nil.
ToBoolSlice - returns a bool slice of the pointer passed in.
ToByte - returns the value of the byte pointer passed in.
ToByteDefault - returns the value of the byte pointer passed in, or 0 if the pointer is nil.
ToByteSlice - returns a byte slice of the pointer passed in.
ToFloat32 - returns the value of the float32 pointer passed in.
ToFloat32Default - returns the value of the float32 pointer passed in, or 0 if the pointer is nil.
ToFloat32Slice - returns a float32 slice of the pointer passed in.
ToFloat64 - returns the value of the float64 pointer passed in.
ToFloat64Default - returns the value of the float64 pointer passed in, or 0 if the pointer is nil.
ToFloat64Slice - returns a float64 slice of the pointer passed in.
ToInt - returns the value of the int pointer passed in.
ToInt16 - returns the value of the int16 pointer passed in.
ToInt16Default - returns the value of the int16 pointer passed in, or 0 if the pointer is nil.
ToInt16Slice - returns a int16 slice of the pointer passed in.
ToInt32 - returns the value of the int32 pointer passed in.
ToInt32Default - returns the value of the int32 pointer passed in, or 0 if the pointer is nil.
ToInt32Slice - returns a int32 slice of the pointer passed in.
ToInt64 - returns the value of the int64 pointer passed in.
ToInt64Default - returns the value of the int64 pointer passed in, or 0 if the pointer is nil.
ToInt64Slice - returns a int64 slice of the pointer passed in.
ToInt8 - returns the value of the int8 pointer passed in.
ToInt8Default - returns the value of the int8 pointer passed in, or 0 if the pointer is nil.
ToInt8Slice - returns a int8 slice of the pointer passed in.
ToIntDefault - returns the value of the int pointer passed in, or 0 if the pointer is nil.
ToIntSlice - returns a int slice of the pointer passed in.
ToPtr - returns a pointer to the given value.
ToString - returns the value of the string pointer passed in.
ToStringDefault - returns the value of the string pointer passed in, or "" if the pointer is nil.
ToStringSlice - returns a string slice of the pointer passed in.
ToTime - returns the value of the Time pointer passed in.
ToTimeDefault - returns the value of the Time pointer passed in, or 0001-01-01 00:00:00 +0000 UTC if the pointer is nil.
ToTimeSlice - returns a Time slice of the pointer passed in.
ToUint - returns the value of the uint pointer passed in.
ToUint16 - returns the value of the uint16 pointer passed in.
ToUint16Default - returns the value of the uint16 pointer passed in, or 0 if the pointer is nil.
ToUint16Slice - returns a uint16 slice of the pointer passed in.
ToUint32 - returns the value of the uint32 pointer passed in.
ToUint32Default - returns the value of the uint32 pointer passed in, or 0 if the pointer is nil.
ToUint32Slice - returns a uint32 slice of the pointer passed in.
ToUint64 - returns the value of the uint64 pointer passed in.
ToUint64Default - returns the value of the uint64 pointer passed in, or 0 if the pointer is nil.
ToUint64Slice - returns a uint63 slice of the pointer passed in.
ToUint8 -returns the value of the uint8 pointer passed in.
ToUint8Default - returns the value of the uint8 pointer passed in, or 0 if the pointer is nil.
ToUint8Slice - returns a uint8 slice of the pointer passed in.
ToUintDefault - returns the value of the uint pointer passed in, or 0 if the pointer is nil.
ToUintSlice - returns a uint slice of the pointer passed in.
ToValue - returns the value of the pointer passed in.
ToValueDefault - returns the value of the pointer passed in, or the default type value if the pointer is nil.
# Constants
List of DayOfTheWeek.
List of DayOfTheWeek.
List of DayOfTheWeek.
List of DayOfTheWeek.
List of DayOfTheWeek.
List of DayOfTheWeek.
List of DayOfTheWeek.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Trace We recommend you only set this field for debugging purposes.
No description provided by the author
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
No description provided by the author
No description provided by the author
# Structs
APIClient manages communication with the IONOS Cloud VPN Gateway API API v1.0.0 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
Connection Details about the network connection for your VPN Gateway.
Error The Error object is used to represent an error response from the API.
ErrorMessages struct for ErrorMessages.
ESPEncryption Settings for the IPSec SA (ESP) phase.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
IKEEncryption Settings for the initial security exchange phase.
No description provided by the author
IPSecGateway Properties with all data needed to create a new IPSec Gateway.
IPSecGatewayCreate struct for IPSecGatewayCreate.
IPSecGatewayEnsure struct for IPSecGatewayEnsure.
IPSecGatewayMetadata IPSec Gateway Metadata.
IPSecGatewayRead struct for IPSecGatewayRead.
IPSecGatewayReadList struct for IPSecGatewayReadList.
IPSecGatewayReadListAllOf struct for IPSecGatewayReadListAllOf.
IPSecPSK Properties with all data needed to define IPSec Authentication PSK.
IPSecTunnel Properties with all data needed to create a new IPSec Gateway Tunnel.\\ __Note__: there is a limit to the total number of tunnels.
IPSecTunnelAuth Properties with all data needed to define IPSec Authentication.
IPSecTunnelCreate struct for IPSecTunnelCreate.
IPSecTunnelEnsure struct for IPSecTunnelEnsure.
IPSecTunnelMetadata IPSec Tunnel Metadata.
IPSecTunnelRead struct for IPSecTunnelRead.
IPSecTunnelReadList struct for IPSecTunnelReadList.
IPSecTunnelReadListAllOf struct for IPSecTunnelReadListAllOf.
Links URLs to navigate the different pages.
MaintenanceWindow A weekly 4 hour-long window, during which maintenance might occur.
Metadata Metadata of the resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Pagination Pagination information.
ResourceStatus The current status of the resource.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
WireguardEndpoint Properties with all data needed to create a new WireGuard Gateway endpoint.
WireguardGateway Properties with all data needed to create a new WireGuard Gateway.
WireguardGatewayCreate struct for WireguardGatewayCreate.
WireguardGatewayEnsure struct for WireguardGatewayEnsure.
WireguardGatewayMetadata WireGuard Gateway Metadata.
WireguardGatewayMetadataAllOf struct for WireguardGatewayMetadataAllOf.
WireguardGatewayRead struct for WireguardGatewayRead.
WireguardGatewayReadList struct for WireguardGatewayReadList.
WireguardGatewayReadListAllOf struct for WireguardGatewayReadListAllOf.
WireguardPeer Properties with all data needed to create a new WireGuard Gateway Peer.\\ __Note__: there is a limit to the total number of peers.
WireguardPeerCreate struct for WireguardPeerCreate.
WireguardPeerEnsure struct for WireguardPeerEnsure.
WireguardPeerMetadata WireGuard Peer Metadata.
WireguardPeerRead struct for WireguardPeerRead.
WireguardPeerReadList struct for WireguardPeerReadList.
WireguardPeerReadListAllOf struct for WireguardPeerReadListAllOf.
# Interfaces
No description provided by the author
# Type aliases
DayOfTheWeek The name of the week day.
IPSecGatewaysApiService IPSecGatewaysApi service.
IPSecTunnelsApiService IPSecTunnelsApi service.
No description provided by the author
ServerConfigurations stores multiple ServerConfiguration items.
TLSDial can be assigned to a http.Transport's DialTLS field.
WireguardGatewaysApiService WireguardGatewaysApi service.
WireguardPeersApiService WireguardPeersApi service.