API docs by Redocly

IONOS Logging REST API (0.0.1)

Download OpenAPI specification:Download

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.

Pipelines

A pipeline consists of the building blocks of a centralized logging system including supported log agents and log sources and also public endpoints to push and access logs.

List pipelines

Retrieves a list of all logging pipelines.

Authorizations:
tokenAuth
query Parameters
limit
integer >= 0
Default: 0

the maximum number of elements to return (use together with offset for pagination). Default to 100

offset
integer >= 1
Default: 1

the first element (of the total list of elements) to include in the response (use together with limit for pagination). Default to 0

orderBy
string
Enum: "createdDate" "lastModifiedDate" "name"

Sorts the results alphanumerically in ascending order based on the specified property

Responses

Response samples

Content type
application/json
{
  • "id": "logging",
  • "type": "collection",
  • "items": [
    ]
}

Create a pipeline

Creates a new logging pipeline.

Authorizations:
tokenAuth
Request Body schema: application/json

The pipeline to be created.

required
object (PipelineCreateProperties)

Create pipeline properties

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "3d0845cf-68ab-4421-b816-2d47ad8dfd62",
  • "metadata": {
    },
  • "properties": {
    }
}

Fetch a pipeline

You can retrieve a pipeline by using its ID. This value can be found in the response body when a pipeline is created or when you GET a list of pipelines.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string

The unique ID of the pipeline

Responses

Response samples

Content type
application/json
{
  • "id": "3d0845cf-68ab-4421-b816-2d47ad8dfd62",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete a pipeline

Delete a logging pipeline.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string

The unique ID of the pipeline

Responses

Response samples

Content type
application/json
{
  • "id": "3d0845cf-68ab-4421-b816-2d47ad8dfd62",
  • "metadata": {
    },
  • "properties": {
    }
}

Patch a pipeline

Patch attributes of a logging pipeline.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string

The unique ID of the pipeline

Request Body schema: application/json

The modified pipeline.

required
object (PipelinePatchProperties)

Patch pipeline properties

Responses

Request samples

Content type
application/json
{
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "3d0845cf-68ab-4421-b816-2d47ad8dfd62",
  • "metadata": {
    },
  • "properties": {
    }
}

Renews the key of a Pipeline

Generates a new key for a pipeline invalidating the old one. The key is used for authentication when sending logs (Shared_Key parameter in the context of fluent-bit).

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string

The unique ID of the pipeline

Responses

Response samples

Content type
application/json
{
  • "key": "string"
}