ionoscloud-logging 2.0.0

IONOS Logging Service REST API

ionoscloud-logging

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.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.0.1
• Package version: 2.0.0
• Generator version: 7.13.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/ionos-cloud/sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ionos-cloud/sdk-python.git)

Then import the package:

import ionoscloud_logging

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ionoscloud_logging

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ionoscloud_logging
from ionoscloud_logging.rest import ApiException
from pprint import pprint
import os

# Defining the host is optional and defaults to https://logging.de-fra.ionos.com
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_logging.Configuration(
    host = "https://logging.de-fra.ionos.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): tokenAuth
configuration = ionoscloud_logging.Configuration(
    token = os.environ["IONOS_TOKEN"]
)


# Enter a context with an instance of the API client
with ionoscloud_logging.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_logging.CentralApi(api_client)
    central_id = '40740a56-ee77-5bff-8abc-2dda26b3144f' # str | The ID (UUID) of the CentralLogging.

    try:
        # Retrieve CentralLogging
        api_response = api_instance.central_find_by_id(central_id)
        print("The response of CentralApi->central_find_by_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CentralApi->central_find_by_id: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
CentralApi	central_find_by_id	GET /central/{centralId}	Retrieve CentralLogging
CentralApi	central_get	GET /central	Retrieve all CentralLogging
CentralApi	central_put	PUT /central/{centralId}	Ensure CentralLogging
KeyApi	pipelines_key_post	POST /pipelines/{pipelineId}/key	Create Key
PipelinesApi	pipelines_delete	DELETE /pipelines/{pipelineId}	Delete Pipeline
PipelinesApi	pipelines_find_by_id	GET /pipelines/{pipelineId}	Retrieve Pipeline
PipelinesApi	pipelines_get	GET /pipelines	Retrieve all Pipelines
PipelinesApi	pipelines_patch	PATCH /pipelines/{pipelineId}	Updates Pipeline
PipelinesApi	pipelines_post	POST /pipelines	Create Pipeline

Documentation For Models

• CentralLogging
• CentralLoggingCreate
• CentralLoggingEnsure
• CentralLoggingRead
• CentralLoggingReadList
• Error
• ErrorMessagesInner
• KeyRead
• Links
• Metadata
• MetadataForCentralLogging
• MetadataWithStatus
• Pagination
• Pipeline
• PipelineCreate
• PipelineNoAddr
• PipelineNoAddrLogsInner
• PipelineNoAddrLogsInnerDestinationsInner
• PipelinePatch
• PipelineRead
• PipelineReadList

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

• Type: Bearer authentication (JWT)

Author