Overview

The IONOS Cloud SDK for GO provides you with access to the IONOS Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in GO . The SDK for GO wraps the IONOS Cloud API. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.

Getting Started

Before you begin you will need to have signed-up for a IONOS Cloud account. The credentials you setup during sign-up will be used to authenticate against the API.

Installation

Install the Go language from from the official Go installation guide.

The GOPATH environment variable specifies the location of your Go workspace. It is likely the only environment variable you will need to set when developing Go code. This is an example of pointing to a workspace configured under your home directory:

mkdir -p ~/go/bin
export GOPATH=~/go
export GOBIN=$GOPATH/bin
export PATH=$PATH:$GOBIN

The following go command will download sdk-go to your configured GOPATH:

go get "github.com/ionos-cloud/sdk-go"

The source code of the package will be located here:

$GOPATH/src/github.com/ionos-cloud/sdk-go

Create main package file example.go:

package main

import (
    "fmt"
)

func main() {
}

Include the IONOS Cloud SDK for Go under the list of imports.

import(
    "fmt"

    "github.com/ionos-cloud/sdk-go"
)

Authentication

The username and passwod or the authentication token can be manually specified when initializing the sdk client:

client := ionoscloud.NewAPIClient(ionoscloud.NewConfiguration(username, password, token, apiUrl))

Environment variables can also be used. The sdk uses the following variables:

• IONOS_USERNAME - to specify the username used to login

• IONOS_PASSWORD - to specify the password

• IONOS_TOKEN - if an authentication token is being used

• IONOS_API_URL - to overwrite the api endpoint: api.ionos.com - if it is not set, the default value will be used

In this case, the client configuration needs to be initialized using NewConfigurationFromEnv()

client := ionoscloud.NewAPIClient(ionoscloud.NewConfigurationFromEnv())

Caution: You will want to ensure you follow security best practices when using credentials within your code or stored in a file.

Environment Variables

Depth

Many of the List or Get operations will accept an optional depth argument. Setting this to a value between 0 and 5 affects the amount of data that is returned. The details returned vary depending on the resource being queried, however, it generally follows this pattern.

How to set Depth parameter:

⚠️ Please use this parameter with caution. We recommend using the default value and raising its value only if it is needed.

• On the configuration level:

configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "URL")  
configuration.SetDepth(5)  

Using this method, the depth parameter will be set on all the API calls.

• When calling a method:

request := apiClient.DataCentersApi.DatacentersGet(context.Background()).Depth(1)

Using this method, the depth parameter will be set on the current API call.

• Using the default value:

If the depth parameter is not set, it will have the default value from the API that can be found here.

Note: The priority for setting the depth parameter is: set on function call > set on configuration level > set using the default value from the API

Pretty

The operations will also accept an optional pretty argument. Setting this to a value of true or false controls whether response is pretty-printed (with indentation and new lines). By default, the SDK sets the pretty argument to true.

Changing the base URL

Changing the base URL for the HTTP operation is possible by using the following function:

requestProperties.SetURL("https://api.ionos.com/cloudapi/v6")

Feature Reference

The IONOS Cloud SDK for GO aims to offer access to all resources in the IONOS Cloud API and also offers some additional features that make the integration easier:

• authentication for API calls

• handling of asynchronous requests

FAQ

1. How can I open a bug/feature request?

Bugs & feature requests can be open on the repository issues: https://github.com/ionos-cloud/sdk-go/issues/new/choose

1. Can I contribute to the GO SDK?

Pure SDKs are automatically generated using OpenAPI Generator and don’t support manual changes. If you need changes please open an issue and we’ll try to take care of it.

Debugging

If you want to see the API call request and response messages, you need to set the Debug field in the Configuration struct:

package main
import "github.com/ionos-cloud/sdk-go/v5"
func main() {
    // create your configuration. replace username, password, token and url with correct values, or use NewConfigurationFromEnv()
    // if you have set your env variables as explained above
    cfg := ionoscloud.NewConfiguration("username", "password", "token", "hostUrl")
    // enable request and response logging
    cfg.Debug = true
    // create you api client with the configuration
    apiClient := ionoscloud.NewAPIClient(cfg)
}

⚠️ Note: We recommend you only set this field for debugging purposes. Disable it in your production environments because it can log sensitive data. It logs the full request and response without encryption, even for an HTTPS call. Verbose request and response logging can also significantly impact your application’s performance.

6.1.10 (December, 2023)

Features:

• Add proxyProtocol parameter for ALB and NLB targets

Fixes:

• Allow setting Host and Scheme when creating a client with a serverUrl (@maxbischoff)

Enhancements

• Remove usage of deprecated ioutil package (@avorima)

Documentation

• Move docs for Url with context to api_doc.mustache

6.1.9 (September, 2023)

Features:

• Support injecting x-contract-number header through environment variable.

6.1.8 (July, 2023)

Features:

Added support for IPv6:

• New parameter on DatacenterProperties: Ipv6CidrBlock

• New parameter on LanProperties and LanPropertiesPost: Ipv6CidrBlock

• New parameters on NicProperties: Dhcpv6, Ipv6CidrBlock and Ipv6Ips

Fixes:

• Go client backoff now respects context cancellation

Full Changelog: https://github.com/ionos-cloud/sdk-go/compare/v6.1.7...v6.1.8

6.1.7 (June, 2023)

Features:

• New licenceType supported: RHEL

6.1.5 (March, 2023)

Features:

• Added generic functions for utility package

Fixes:

• Removed swagger

Updated:

• Library dependencies

6.1.4 (January 26th, 2022)

Features:

• Added placementGroupId and vnet parameters.

Fixes:

• Allow multiple values to be set for the same filter key

6.1.3 (August 30th, 2022)

Fixes:

• Fix return type of NewGenericOpenAPIError

6.1.2 (August 4th, 2022)

Fixes :

• Changed from manageDbaas to manageDBaaS field in model_group_properties.go : provides privilege for a group to manage DBaaS related functionality. Admin users already have it enabled by default.

• Issue #26

6.1.1 (July 14th, 2022)

Features :

• Added manageDbaas field in model_group_properties.go : provides privilege for a group to manage DBaaS related functionality. Admin users already here this enabled by default.

• Added deleteVolumes to DatacentersServersDelete function: If true, all attached storage volumes will also be deleted.

• Added bootOrder to model_volume_properties : Determines whether the volume will be used as a boot volume. Set to `NONE`, the volume will not be used as boot volume. Set to `PRIMARY`, the volume will be used as boot volume and all other volumes must be set to `NONE`. Set to `AUTO` or `null` requires all volumes to be set to `AUTO` or `null`; this will use the legacy behavior, which is to use the volume as a boot volume only if there are no other volumes or cdrom devices. | [optional] [default to 'AUTO'] |

• Added helper function HttpNotFound in response.go

6.1.0 (June 16th, 2022)

Enhancements:

• added Application Load Balancer and Target Group, 18 new models and 2 new apis

v6.0.1 (January, 2022)

Enhancements:

• new parameter on KubernetesClusterProperties, KubernetesClusterPropertiesForPost: public

• new parameter on KubernetesNodePoolProperties, KubernetesNodePoolPropertiesForPost: gatewayIp

• allow fields that are explicitly nullable to be sent with null values

• updated oauth import

• depth parameter:

  • new method SetDepth on configuration that allows setting a value for the depth parameter on all the API calls for the client

  • changed the default value of depth parameter from 10 to 0

  • this affects the amount of data that is returned on GET methods. If there is a need to change the value, please do it with caution and only if it is needed.

v6.0.0 (December, 2021)

Enhancements:

• changed structure ApiK8sNodepoolsPostRequest, changed name of kubernetesNodePool field from KubernetesNodePool to KubernetesNodePoolForPost

• changed structure ApiK8sNodepoolsPutRequest, changed type of KubernetesNodePoolForPut field from kubernetesNodePoolForPut to kubernetesNodePool

Fixes:

• fixed sporadic EOF error seen from server

• fixed overwriting https with http for host endpoint that starts with http. It now allows user to enter a url that starts with http

• added Password field to UserPropertiesPut to allow user password update

v6.0.0-beta.9 (November, 2021)

Enhancements:

• added support for maxResults query parameter on GET requests

Features:

• renamed Apis services: LansApi to LANsApi

• renamed BackupUnitProperties to BackupUnit on BackupunitsPatch method

Documentation:

• updated descriptions

v6.0.0-beta.8 (October, 2021)

Enhancements:

• improved code in sync with Sonar Cloud requirements:

  • added global constant FilterQueryParam

  • renamed global constant FORMAT_STRING to FormatStringErr

v6.0.0-beta.7 (October, 2021)

Enhancements:

• added support for filter query parameters on GET requests: Filter()

• added support for overwriting the host-url value via IONOS_API_URL environment variable

• added gofmt check's results

v6.0.0-beta.6 (September, 2021)

Features:

• added Offset, Limit and Links to IpBlocks

• removed Public parameter from KubernetesClusterProperties

• removed GatewayIp parameter from KubernetesNodePoolProperties

v6.0.0-beta.5 (September, 2021)

Features:

• added imageAlias to VolumeProperties

• added Offset, Limit and Links to User

• removed gatewayIp parameter from KubernetesClusterProperties

• added GatewayIp parameter from KubernetesNodePoolProperties

All URIs are relative to https://api.ionos.com/cloudapi/v6

ContractsGet

Get Contract Information

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiContractsGetRequest struct via the builder pattern

Return type

HTTP request headers

• Content-Type: Not defined

• Accept: application/json