Rotate Key

Rotates the monitoring pipeline key, invalidating the previous one. The new key is returned only in this response and cannot be retrieved again.

post

/pipelines/{pipelineId}/key

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

201

Rotate Key succeeded.

application/json

Contains the newly generated pipeline key, returned only by the key rotation operation. The value cannot be retrieved again later.

keystringRequired

The key is shared once and is used to authenticate the metrics sent to the pipeline.

Example: momSrlgAAEmaYEvBsMr^HsYn

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

post/pipelines/{pipelineId}/key

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

{
  "key": "momSrlgAAEmaYEvBsMr^HsYn"
}