Go API client for ionoscloud

The Logging Service offers a centralized platform to collect and store logs from various systems and applications. It includes tools to search, filter, visualize, and create alerts based on your log data. This API provides programmatic control over logging pipelines, enabling you to create new pipelines or modify existing ones. It mirrors the functionality of the DCD visual tool, ensuring a consistent experience regardless of your chosen interface.

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.0.1
• Package version: 1.3.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://logging.de-fra.ionos.com - service endpoint for location de-fra
• https://logging.de-txl.ionos.com - service endpoint for location de-txl
• https://logging.es-vit.ionos.com - service endpoint for location es-vit
• https://logging.gb-bhx.ionos.com - service endpoint for location gb-bhx
• https://logging.gb-lhr.ionos.com - service endpoint for location gb-lhr
• https://logging.fr-par.ionos.com - service endpoint for location fr-par
• https://logging.us-mci.ionos.com - service endpoint for location us-mci

By default, https://logging.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.

NOTE: We recommend passing the URL without the https:// or http:// prefix. The SDK checks and adds it if necessary when configurations are created using NewConfiguration or NewConfigurationFromEnv. This is to avoid issues caused by typos in the prefix that cannot be easily detected and debugged.

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://logging.de-fra.ionos.com

API Endpoints table

Class	Method	HTTP request	Description
CentralApi	CentralFindById	Get /central/{centralId}	Retrieve CentralLogging
CentralApi	CentralGet	Get /central	Retrieve all CentralLogging
CentralApi	CentralPut	Put /central/{centralId}	Ensure CentralLogging
KeyApi	PipelinesKeyPost	Post /pipelines/{pipelineId}/key	Create Key
PipelinesApi	PipelinesDelete	Delete /pipelines/{pipelineId}	Delete Pipeline
PipelinesApi	PipelinesFindById	Get /pipelines/{pipelineId}	Retrieve Pipeline
PipelinesApi	PipelinesGet	Get /pipelines	Retrieve all Pipelines
PipelinesApi	PipelinesPatch	Patch /pipelines/{pipelineId}	Updates Pipeline
PipelinesApi	PipelinesPost	Post /pipelines	Create Pipeline

Documentation For Models

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

API models list

• CentralLogging
• CentralLoggingCreate
• CentralLoggingEnsure
• CentralLoggingRead
• CentralLoggingReadList
• CentralLoggingReadListAllOf
• Error
• ErrorMessages
• KeyRead
• Links
• Metadata
• MetadataForCentralLogging
• MetadataForCentralLoggingAllOf
• MetadataWithStatus
• MetadataWithStatusAllOf
• Pagination
• Pipeline
• PipelineAllOf
• PipelineCreate
• PipelineNoAddr
• PipelineNoAddrLogs
• PipelineNoAddrLogsDestinations
• PipelinePatch
• PipelineRead
• PipelineReadList
• PipelineReadListAllOf

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