AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

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

get

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

Authorizations
Query parameters
offsetinteger · int32Optional

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

Default: 0Example: 0
limitinteger · int32 · min: 1 · max: 1000Optional

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

Default: 100Example: 100
orderBystring · enumOptional

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

Default: -createdDatePossible values:
Responses
200
Returned all requested Pipelines successfully.
application/json
Responseall of
and
get
GET /pipelines HTTP/1.1
Host: logging.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "930b1f07-e846-54fa-b447-9b78905ff2ef",
  "type": "collection",
  "href": "/pipelines",
  "items": [
    {
      "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
      "type": "pipeline",
      "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "Pipeline1",
        "logs": [
          {
            "source": "generic",
            "tag": "tag1",
            "protocol": "http",
            "destinations": [
              {
                "type": "loki",
                "retentionInDays": 30
              }
            ]
          }
        ],
        "tcpAddress": "tcp-1234.logging.de-txl.ionos.com",
        "httpAddress": "1234.logging.de-txl.ionos.com",
        "grafanaAddress": "grafana.logging.de-txl.ionos.com",
        "resourceTier": "s",
        "key": "momSrlgAAEmaYEvBsMr^HsYn"
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create Pipeline

post

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
Body

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
201
Pipeline successfully created.
application/json
post
POST /pipelines HTTP/1.1
Host: logging.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "properties": {
    "name": "Pipeline1",
    "logs": [
      {
        "source": "generic",
        "tag": "tag1",
        "protocol": "http",
        "destinations": [
          {
            "type": "loki",
            "retentionInDays": 30
          }
        ]
      }
    ]
  }
}
{
  "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  "type": "pipeline",
  "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "Pipeline1",
    "logs": [
      {
        "source": "generic",
        "tag": "tag1",
        "protocol": "http",
        "destinations": [
          {
            "type": "loki",
            "retentionInDays": 30
          }
        ]
      }
    ],
    "tcpAddress": "tcp-1234.logging.de-txl.ionos.com",
    "httpAddress": "1234.logging.de-txl.ionos.com",
    "grafanaAddress": "grafana.logging.de-txl.ionos.com",
    "resourceTier": "s",
    "key": "momSrlgAAEmaYEvBsMr^HsYn"
  }
}

Retrieve Pipeline

get

Returns the Pipeline by ID.

Authorizations
Path parameters
pipelineIdstring · uuidRequired

The ID (UUID) of the Pipeline.

Example: f72521ba-1590-5998-bf96-6eb997a5887d
Responses
200
Getting Pipeline was successful.
application/json
get
GET /pipelines/{pipelineId} HTTP/1.1
Host: logging.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  "type": "pipeline",
  "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "Pipeline1",
    "logs": [
      {
        "source": "generic",
        "tag": "tag1",
        "protocol": "http",
        "destinations": [
          {
            "type": "loki",
            "retentionInDays": 30
          }
        ]
      }
    ],
    "tcpAddress": "tcp-1234.logging.de-txl.ionos.com",
    "httpAddress": "1234.logging.de-txl.ionos.com",
    "grafanaAddress": "grafana.logging.de-txl.ionos.com",
    "resourceTier": "s",
    "key": "momSrlgAAEmaYEvBsMr^HsYn"
  }
}

Delete Pipeline

delete

Deletes the specified Pipeline.

Authorizations
Path parameters
pipelineIdstring · uuidRequired

The ID (UUID) of the Pipeline.

Example: f72521ba-1590-5998-bf96-6eb997a5887d
Responses
202
Deleting Pipeline was successful.
delete
DELETE /pipelines/{pipelineId} HTTP/1.1
Host: logging.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

No content

Updates Pipeline

patch

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

Authorizations
Path parameters
pipelineIdstring · uuidRequired

The ID (UUID) of the Pipeline.

Example: f72521ba-1590-5998-bf96-6eb997a5887d
Body
metadataanyOptional

Metadata

Responses
200
Pipeline successfully updated.
application/json
patch
PATCH /pipelines/{pipelineId} HTTP/1.1
Host: logging.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "metadata": {},
  "properties": {
    "name": "Pipeline1",
    "logs": [
      {
        "source": "generic",
        "tag": "tag1",
        "protocol": "http",
        "destinations": [
          {
            "type": "loki",
            "retentionInDays": 30
          }
        ]
      }
    ]
  }
}
{
  "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  "type": "pipeline",
  "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "Pipeline1",
    "logs": [
      {
        "source": "generic",
        "tag": "tag1",
        "protocol": "http",
        "destinations": [
          {
            "type": "loki",
            "retentionInDays": 30
          }
        ]
      }
    ],
    "tcpAddress": "tcp-1234.logging.de-txl.ionos.com",
    "httpAddress": "1234.logging.de-txl.ionos.com",
    "grafanaAddress": "grafana.logging.de-txl.ionos.com",
    "resourceTier": "s",
    "key": "momSrlgAAEmaYEvBsMr^HsYn"
  }
}
PreviousLogging ServiceNextKey

Was this helpful?