search

ionos-cloud / sdk-go-logging

Apache License 2.0
0 stars 0 forks source link

readme

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.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import ionoscloud "github.com/ionos-cloud/sdk-go-logging"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ionoscloud.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), ionoscloud.ContextServerVariables, map[string]string{
    "basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

Documentation for API Endpoints

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

Class Method HTTP request Description
CentralApi CentralLoggingGet Get /central Gets the central logging properties.
CentralApi CentralLoggingToggle Put /central Toggles the central logging.
PipelinesApi PipelinesDelete Delete /pipelines/{pipelineId} Delete a pipeline
PipelinesApi PipelinesFindById Get /pipelines/{pipelineId} Fetch a pipeline
PipelinesApi PipelinesGet Get /pipelines List pipelines
PipelinesApi PipelinesKeyPost Post /pipelines/{pipelineId}/key Renews the key of a Pipeline
PipelinesApi PipelinesPatch Patch /pipelines/{pipelineId} Patch a pipeline
PipelinesApi PipelinesPost Post /pipelines Create a pipeline

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
        context.Background(),
        sw.ContextAPIKeys,
        map[string]sw.APIKey{
            "Authorization": {Key: "API_KEY_STRING"},
        },
    )
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

Author