Go API client for ionoscloud

Object Storage Management API is a RESTful API that manages the object storage service configuration for IONOS Cloud.

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.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

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://s3.ionos.com - Production

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

API Endpoints table

Class	Method	HTTP request	Description
AccesskeysApi	AccesskeysDelete	Delete /accesskeys/{accesskeyId}	Delete AccessKey
AccesskeysApi	AccesskeysFindById	Get /accesskeys/{accesskeyId}	Retrieve AccessKey
AccesskeysApi	AccesskeysGet	Get /accesskeys	Retrieve all Accesskeys
AccesskeysApi	AccesskeysPost	Post /accesskeys	Create AccessKey
AccesskeysApi	AccesskeysPut	Put /accesskeys/{accesskeyId}	Ensure AccessKey
AccesskeysApi	AccesskeysRenew	Put /accesskeys/{accesskeyId}/renew	Ensure AccessKey
RegionsApi	RegionsFindByRegion	Get /regions/{region}	Retrieve Region
RegionsApi	RegionsGet	Get /regions	Retrieve all Regions

Documentation For Models

All URIs are relative to https://s3.ionos.com

API models list

• AccessKey
• AccessKeyCreate
• AccessKeyEnsure
• AccessKeyRead
• AccessKeyReadList
• AccessKeyReadListAllOf
• Bucket
• BucketCreate
• BucketEnsure
• BucketRead
• BucketReadList
• BucketReadListAllOf
• Error
• ErrorMessages
• Links
• Metadata
• MetadataWithStatus
• MetadataWithStatusAllOf
• MetadataWithSupportedRegions
• MetadataWithSupportedRegionsAllOf
• Pagination
• Region
• RegionCapability
• RegionCreate
• RegionEnsure
• RegionRead
• RegionReadList
• RegionReadListAllOf
• StorageClass
• StorageClassCreate
• StorageClassEnsure
• StorageClassRead
• StorageClassReadList
• StorageClassReadListAllOf

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