Pipelines

A pipeline consists of the generic rules and configurations of a monitoring pipeline instance.

This tag groups all operations for pipelines.

Retrieve all Pipelines

get

/pipelines

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

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

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

Pagination information. The offset and limit parameters are used to navigate the list of elements. The _links object contains URLs to navigate the different pages.

idstring · uuidRequired

ID of the list of Pipeline resources.

Example: 930b1f07-e846-54fa-b447-9b78905ff2ef

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the list of Pipeline resources.

Example: /pipelines

offsetintegerRead-onlyRequired

The offset specified in the request (if none was specified, the default offset is 0).

Example: 0

limitintegerRead-onlyRequired

The limit specified in the request (if none was specified, use the endpoint's default pagination limit).

Example: 42

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/pipelines

GET /pipelines HTTP/1.1
Host: monitoring.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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>",
        "status": "AVAILABLE",
        "statusMessage": null,
        "key": "momSrlgAAEmaYEvBsMr^HsYn",
        "grafanaEndpoint": "https://grafana.logging.de-txl.ionos.com",
        "httpEndpoint": "https://f8ss7fgr7s-metrics.jf9ejf8t6hrt.monitoring.de-txl.ionos.com"
      },
      "properties": {
        "name": "Pipeline1"
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create Pipeline

post

/pipelines

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

AuthorizationstringRequired

The token can be generated using the Authentication API.

Body

metadataanyOptional

Metadata

Responses

201

Pipeline successfully created.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

post

/pipelines

POST /pipelines HTTP/1.1
Host: monitoring.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "metadata": {},
  "properties": {
    "name": "Pipeline1"
  }
}

{
  "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>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "key": "momSrlgAAEmaYEvBsMr^HsYn",
    "grafanaEndpoint": "https://grafana.logging.de-txl.ionos.com",
    "httpEndpoint": "https://f8ss7fgr7s-metrics.jf9ejf8t6hrt.monitoring.de-txl.ionos.com"
  },
  "properties": {
    "name": "Pipeline1"
  }
}

Retrieve Pipeline

get

/pipelines/{pipelineId}

Returns the Pipeline by ID.

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

pipelineIdstring · uuidRequired

The ID (UUID) of the Pipeline.

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

Responses

200

Getting Pipeline was successful.

application/json

idstring · uuidRequired

The ID (UUID) of the Pipeline.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the Pipeline.

Example: /pipelines/f72521ba-1590-5998-bf96-6eb997a5887d

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/pipelines/{pipelineId}

GET /pipelines/{pipelineId} HTTP/1.1
Host: monitoring.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "key": "momSrlgAAEmaYEvBsMr^HsYn",
    "grafanaEndpoint": "https://grafana.logging.de-txl.ionos.com",
    "httpEndpoint": "https://f8ss7fgr7s-metrics.jf9ejf8t6hrt.monitoring.de-txl.ionos.com"
  },
  "properties": {
    "name": "Pipeline1"
  }
}

Ensure Pipeline

put

/pipelines/{pipelineId}

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

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

pipelineIdstring · uuidRequired

The ID (UUID) of the Pipeline.

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

Body

idstring · uuidRequired

The ID (UUID) of the Pipeline.

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

metadataanyOptional

Metadata

Responses

200

Pipeline successfully updated.

application/json

idstring · uuidRequired

The ID (UUID) of the Pipeline.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the Pipeline.

Example: /pipelines/f72521ba-1590-5998-bf96-6eb997a5887d

201

Pipeline successfully ensured.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

409

Conflict

The UUID is already taken by another party, follow the guides to generate UUIDs uniquely.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

put

/pipelines/{pipelineId}

PUT /pipelines/{pipelineId} HTTP/1.1
Host: monitoring.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  "metadata": {},
  "properties": {
    "name": "Pipeline1"
  }
}

{
  "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>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "key": "momSrlgAAEmaYEvBsMr^HsYn",
    "grafanaEndpoint": "https://grafana.logging.de-txl.ionos.com",
    "httpEndpoint": "https://f8ss7fgr7s-metrics.jf9ejf8t6hrt.monitoring.de-txl.ionos.com"
  },
  "properties": {
    "name": "Pipeline1"
  }
}

Delete Pipeline

delete

/pipelines/{pipelineId}

Deletes the specified Pipeline.

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

pipelineIdstring · uuidRequired

The ID (UUID) of the Pipeline.

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

Responses

202

Deleting Pipeline was successful.

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

delete

/pipelines/{pipelineId}

DELETE /pipelines/{pipelineId} HTTP/1.1
Host: monitoring.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

PreviousMonitoring Service NextKey

Last updated 2 months ago

Was this helpful?

Good morning

hashtagRetrieve all Pipelines

Bad Request

Unauthorized

Not Allowed

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagCreate Pipeline

Bad Request

Unauthorized

Not Allowed

Unsupported Media Type

Unprocessable Entity

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagRetrieve Pipeline

Bad Request

Unauthorized

Not Allowed

Not Found

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagEnsure Pipeline

Bad Request

Unauthorized

Not Allowed

Not Found

Conflict

Unsupported Media Type

Unprocessable Entity

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

hashtagDelete Pipeline

Bad Request

Unauthorized

Not Allowed

Not Found

Too Many Requests

Internal Server Error

Service Unavailable

Unexpected Internal Server Error

Retrieve all Pipelines

Create Pipeline

Retrieve Pipeline

Ensure Pipeline

Delete Pipeline