Retrieve All Monitoring Pipelines

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

To retrieve all the Monitoring Pipelines, perform a GET request.

Request

The following is a sample request.

curl --location \
--request GET 'https://monitoring.de-txl.ionos.com/pipelines' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $TOKEN'

Query Parameters

Below is the list of optional Query Parameters:

Query Parameters	Type	Description	Example
orderBy	string	The field to order the results by. If not provided, the results will be ordered by the default field. Default: "-createdDate" Enum: "-createdDate", "-lastModifiedDate", "-name", "name", "createdDate", "lastModifiedDate"	"-createdDate"

Request Header Parameters

To make authenticated requests to the API, the following fields are mandatory in the request header:

Header Parameters	Required	Type	Description
Authorization	yes	string	The Bearer token enables requests to authenticate using a JSON Web Token (JWT). The token can be generated using the Authentication API.

Response

The following is a sample response. The values returned by each response differ based on the request.

200 Successful operation

{
  "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.jf9ejf8t6hrt.logging.de-txl.ionos.com",
        "httpEndpoint": "https://f8ss7fgr7s-metrics.jf9ejf8t6hrt.monitoring.de-txl.ionos.com"
      },
      "properties": {
        "name": "Pipeline1"
      }
    }
  ]
}

Result: All existing Monitoring Pipelines and their details are successfully obtained.