API docs by Redocly

IONOS Logging Service 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.

This tag groups all operations for pipelines.

Retrieve all Pipelines

This endpoint enables retrieving all Pipelines using pagination and optional filters.

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

The maximum number of elements to return. Use together with offset for pagination.

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

The field to order the results by. If not provided, the results will be ordered by the default field.

Responses

Response samples

Content type
application/json
{
  • "id": "930b1f07-e846-54fa-b447-9b78905ff2ef",
  • "type": "collection",
  • "href": "/pipelines",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create Pipeline

Creates a new Pipeline.

The full Pipeline needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
Request Body schema: application/json

Pipeline to create.

required
object (PipelineNoAddr)

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.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  • "type": "pipeline",
  • "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Pipeline

Returns the Pipeline by ID.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string <uuid>
Example: f72521ba-1590-5998-bf96-6eb997a5887d

The ID (UUID) of the Pipeline.

Responses

Response samples

Content type
application/json
{
  • "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  • "type": "pipeline",
  • "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
  • "metadata": {
    },
  • "properties": {
    }
}

Updates Pipeline

Changes Pipeline with the provided ID. Values provides will replace the existing data.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string <uuid>
Example: f72521ba-1590-5998-bf96-6eb997a5887d

The ID (UUID) of the Pipeline.

Request Body schema: application/json

patch Pipeline

object

Metadata

required
object (PipelineNoAddr)

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.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  • "type": "pipeline",
  • "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Pipeline

Deletes the specified Pipeline.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string <uuid>
Example: f72521ba-1590-5998-bf96-6eb997a5887d

The ID (UUID) of the Pipeline.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Key

Generates a new key for a pipeline invalidating the old one. The key is used for authentication when sending logs.

This tag groups all operations for key.

Create Key

Creates a new Key.

The full Key needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string <uuid>
Example: f72521ba-1590-5998-bf96-6eb997a5887d

The ID (UUID) of the Pipeline.

Request Body schema: application/json

Key to create.

object (KeyCreate)

Generates a new key for a pipeline invalidating the old one. The key is used for authentication when sending logs.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "key": "momSrlgAAEmaYEvBsMr^HsYn"
}

Central

Central logging is a feature that allows you to use other products to send logs to a central location. This is useful for logging and analyzing logs from multiple sources.

This tag groups all operations for central.

Retrieve all CentralLogging

This endpoint enables retrieving all CentralLogging using pagination and optional filters.

Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
{
  • "id": "d9a741e7-1132-5b47-94d3-aabefa619c91",
  • "type": "collection",
  • "href": "/central",
  • "items": [
    ]
}

Retrieve CentralLogging

Returns the CentralLogging by ID.

Authorizations:
tokenAuth
path Parameters
centralId
required
string <uuid>
Example: 40740a56-ee77-5bff-8abc-2dda26b3144f

The ID (UUID) of the CentralLogging.

Responses

Response samples

Content type
application/json
{
  • "id": "40740a56-ee77-5bff-8abc-2dda26b3144f",
  • "type": "centrallogging",
  • "href": "/central/40740a56-ee77-5bff-8abc-2dda26b3144f",
  • "metadata": {
    },
  • "properties": {
    }
}

Ensure CentralLogging

Ensures that the CentralLogging with the provided ID is created or modified. The full CentralLogging needs to be provided to ensure (either update or create) the CentralLogging. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations:
tokenAuth
path Parameters
centralId
required
string <uuid>
Example: 40740a56-ee77-5bff-8abc-2dda26b3144f

The ID (UUID) of the CentralLogging.

Request Body schema: application/json

update CentralLogging

object

Metadata

required
object (CentralLogging)

Central logging is a feature that allows you to use other products to send logs to a central location. This is useful for logging and analyzing logs from multiple sources.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "40740a56-ee77-5bff-8abc-2dda26b3144f",
  • "type": "centrallogging",
  • "href": "/central/40740a56-ee77-5bff-8abc-2dda26b3144f",
  • "metadata": {
    },
  • "properties": {
    }
}