Go API client for ionoscloud

The RESTful API for managing Network File Storage.

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.1.3
• Package version: 1.1.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/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://nfs.de-fra.ionos.com - Frankfurt, Germany
• https://nfs.de-txl.ionos.com - Berlin, Germany
• https://nfs.fr-par.ionos.com - Paris, France
• https://nfs.gb-lhr.ionos.com - London, Great Britain
• https://nfs.es-vit.ionos.com - Logroño, Spain
• https://nfs.us-las.ionos.com - Las Vegas, USA
• https://nfs.us-ewr.ionos.com - Newark, USA
• https://nfs.us-mci.ionos.com - Lenexa, USA

By default, https://nfs.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://nfs.de-fra.ionos.com

API Endpoints table

Class	Method	HTTP request	Description
ClustersApi	ClustersDelete	Delete /clusters/{clusterId}	Delete Cluster
ClustersApi	ClustersFindById	Get /clusters/{clusterId}	Retrieve Cluster
ClustersApi	ClustersGet	Get /clusters	Retrieve Clusters
ClustersApi	ClustersPost	Post /clusters	Create Cluster
ClustersApi	ClustersPut	Put /clusters/{clusterId}	Ensure Cluster
SharesApi	ClustersSharesDelete	Delete /clusters/{clusterId}/shares/{shareId}	Delete Share
SharesApi	ClustersSharesFindById	Get /clusters/{clusterId}/shares/{shareId}	Retrieve Share
SharesApi	ClustersSharesGet	Get /clusters/{clusterId}/shares	Retrieve Shares
SharesApi	ClustersSharesPost	Post /clusters/{clusterId}/shares	Create Share
SharesApi	ClustersSharesPut	Put /clusters/{clusterId}/shares/{shareId}	Ensure Share

Documentation For Models

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

API models list

• Cluster
• ClusterConnections
• ClusterCreate
• ClusterEnsure
• ClusterNfs
• ClusterRead
• ClusterReadList
• ClusterReadListAllOf
• Error
• ErrorMessages
• Links
• Metadata
• MetadataWithPath
• MetadataWithPathAllOf
• MetadataWithStatus
• MetadataWithStatusAllOf
• Pagination
• Share
• ShareClientGroups
• ShareClientGroupsNfs
• ShareCreate
• ShareEnsure
• ShareRead
• ShareReadList
• ShareReadListAllOf

[Back to API list] [Back to Model list]