Key

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

This tag groups all operations for key.

Create Key

post

Creates a new Key.

The full Key needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations

Path parameters

pipelineIdstring · uuidRequired

The ID (UUID) of the Pipeline.

Example: f72521ba-1590-5998-bf96-6eb997a5887d

Body

objectOptional

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

Responses

201

Key successfully created.

application/json

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

415

### Unsupported Media Type The request has an unsupported media type.

application/json

422

### Unprocessable Entity The request was well-formed but was unable to be followed due to semantic errors.

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

HTTPcURLJavaScriptPython

POST /pipelines/{pipelineId}/key HTTP/1.1
Host: monitoring.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "key": "momSrlgAAEmaYEvBsMr^HsYn"
}