Package: ionoscloud-logging
Python API client for ionoscloud_loggingLogging as a Service (LaaS) is a service that provides a centralized logging system where users are able to push and aggregate their system or application logs. This service also provides a visualization platform where users are able to observe, search and filter the logs and also create dashboards and alerts for their data points.
This service can be managed through a browser-based "Data Center Designer" (DCD) tool or via an API.
The API allows you to create logging pipelines or modify existing ones. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.OverviewThe IONOS Cloud SDK for Python provides you with access to the IONOS Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in Python. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.Installation & UsageRequirements:Python >= 3.5pip installSince this package is hosted onPypiyou can install it by using:pipinstallionoscloud-loggingIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/ionos-cloud/sdk-python-logging.gitNote: you may need to runpipwith root permission:sudo pip install git+https://github.com/ionos-cloud/sdk-python-logging.gitThen import the package:importionoscloud_loggingSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--userorsudo python setup.py installto install the package for all usersThen import the package:importionoscloud_loggingNOTE:The Python SDK does not support Python 2. It only supports Python >= 3.5.AuthenticationThe username and passwordorthe authentication token can be manually specified when initializing the SDK client:configuration=ionoscloud_logging.Configuration(username='YOUR_USERNAME',password='YOUR_PASSWORD',token='YOUR_TOKEN')client=ionoscloud_logging.ApiClient(configuration)Environment variables can also be used. This is an example of how one would do that:importosconfiguration=ionoscloud_logging.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),token=os.environ.get('IONOS_TOKEN'))client=ionoscloud_logging.ApiClient(configuration)Warning: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.HTTP proxiesYou can use http proxies by setting the following environment variables:IONOS_HTTP_PROXY- proxy URLIONOS_HTTP_PROXY_HEADERS- proxy headersEach line inIONOS_HTTP_PROXY_HEADERSrepresents one header, where the header name and value is separated by a colon. Newline characters within a value need to be escaped. See this example:Connection: Keep-Alive
User-Info: MyID
User-Group: my long\nheader valueChanging the base URLBase URL for the HTTP operation can be changed in the following way:importosconfiguration=ionoscloud_logging.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),host=os.environ.get('IONOS_API_URL'),server_index=None,)client=ionoscloud_logging.ApiClient(configuration)Certificate pinning:You can enable certificate pinning if you want to bypass the normal certificate checking procedure,
by doing the following:Set env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>You can get the sha256 fingerprint most easily from the browser by inspecting the certificate.Documentation for API EndpointsAll URIs are relative tohttps://logging.de-txl.ionos.comAPI Endpoints tableClassMethodHTTP requestDescriptionPipelinesApipipelines_deleteDELETE/pipelines/{pipelineId}Delete a pipelinePipelinesApipipelines_find_by_idGET/pipelines/{pipelineId}Fetch a pipelinePipelinesApipipelines_getGET/pipelinesList pipelinesPipelinesApipipelines_key_postPOST/pipelines/{pipelineId}/keyRenews the key of a PipelinePipelinesApipipelines_patchPATCH/pipelines/{pipelineId}Patch a pipelinePipelinesApipipelines_postPOST/pipelinesCreate a pipelineDocumentation For ModelsAll URIs are relative tohttps://logging.de-txl.ionos.comAPI models listDestinationErrorMessageErrorResponseMetadataPipelinePipelineCreatePipelineCreatePropertiesPipelineCreatePropertiesLogsPipelineListResponsePipelinePatchPipelinePatchPropertiesPipelinePropertiesPipelineResponsePipelineResponseAllOfPipelineResponseAllOf1PipelinesKeyPost200ResponseProcessor[Back to API list][Back to Model list]