Retrieve Monitoring Pipeline Information

Returns the Monitoring Pipeline by ID.

To retrieve a Monitoring Pipeline, perform a GET request.

Request

The following is a sample request. Remember to replace the {pipelineID} with a valid ID of the specific pipeline whose information you want to access.

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

Path Parameter

Path Parameter	Type	Description	Example
pipelineID	string	The ID (UUID) of the Pipeline.	66a114c7-2ddd-5119-9ddf-5a789f5a5a44

Request Header Parameters

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

Header Parameter	Required	Type	Description
Authorization	yes	string	The Bearer token to enable requests to authenticate using a JSON Web Token (JWT).

Response

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

200 Successful operation

{"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: The Monitoring Pipeline and its details for the specified pipelineID are successfully obtained.

Note: A key is necessary to send metrics through the newly formed monitoring pipeline. For more information about creating a key, see Obtain a New Key.