Modify a Monitoring Pipeline Instance

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.

To ensure that the pipeline with the provided ID is created or modified, perform PUT request.

Request

The following is a sample request. Remember to replace the {pipelineID} with a valid ID of the specific pipeline you want to create or update.

curl --location \
--request PUT 'https://monitoring.de-txl.ionos.com/pipelines/{pipelineID}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $TOKEN' \
--data-raw '{
  "metadata": {},
  "properties": {
    "name": "Pipeline1"
  }
}'

Path Parameters

Below is the list of mandatory path parameters for updating a Monitoring Pipeline:

Path Parameters	Type	Description	Example
pipelineId	string	The ID (UUID) of the Pipeline.	f72521ba-1590-5998-bf96-6eb997a5887d

Request Body Parameters

Request Header Parameters

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

Result: The Monitoring Pipeline is successfully updated or created.