Obtain a new Key

To obtain a new key, perform a PUT request with the complete key configuration. Ensure that you specify all the mandatory details. The optional fields will be automatically populated with default values or left empty if not specified.

Request

To get a new key for a pipeline, you can use the following request. Remember to replace the {pipelineID} with a valid ID of a pipeline to access its key.

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

Path Parameters

You can update the pipelineID value to delete a specific pipeline:

Path Parameters	Type	Description	Example
pipelineID	string	The ID (UUID) of the Pipeline.	85c79b4b-5b40-570a-b788-58dd46ea71e2

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 enable requests to authenticate using a JSON Web Token (JWT).

Response

Generates a new key for a pipeline invalidating the old one. The key is used for authentication when sending metrics.

{
  "key": "momSrlgAAEmaYEvBsMr^HsYn"
}