API docs by Redocly

IONOS Cloud - Monitoring REST API (0.0.1)

Download OpenAPI specification:Download

The monitoring service offers a centralized platform to collect and store metrics.

Pipelines

A pipeline consists of the generic rules and configurations of a monitoring pipeline instance.

This tag groups all operations for pipelines.

Retrieve all Pipelines

This endpoint enables retrieving all Pipelines using pagination and optional filters.

Authorizations:
tokenAuth
query Parameters
orderBy
string
Default: "-createdDate"
Enum: "-createdDate" "-lastModifiedDate" "-name" "name" "createdDate" "lastModifiedDate"

The field to order the results by. If not provided, the results will be ordered by the default field.

Responses

Response samples

Content type
application/json
{
  • "id": "930b1f07-e846-54fa-b447-9b78905ff2ef",
  • "type": "collection",
  • "href": "/pipelines",
  • "items": [
    ]
}

Create Pipeline

Creates a new Pipeline.

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

Authorizations:
tokenAuth
Request Body schema: application/json

Pipeline to create.

object

Metadata

required
object (Pipeline)

A pipeline consists of the generic rules and configurations of a monitoring pipeline instance.

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  • "type": "pipeline",
  • "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Pipeline

Returns the Pipeline by ID.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string <uuid>
Example: f72521ba-1590-5998-bf96-6eb997a5887d

The ID (UUID) of the Pipeline.

Responses

Response samples

Content type
application/json
{
  • "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  • "type": "pipeline",
  • "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
  • "metadata": {
    },
  • "properties": {
    }
}

Ensure Pipeline

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.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string <uuid>
Example: f72521ba-1590-5998-bf96-6eb997a5887d

The ID (UUID) of the Pipeline.

Request Body schema: application/json

update Pipeline

object

Metadata

required
object (Pipeline)

A pipeline consists of the generic rules and configurations of a monitoring pipeline instance.

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "f72521ba-1590-5998-bf96-6eb997a5887d",
  • "type": "pipeline",
  • "href": "/pipelines/f72521ba-1590-5998-bf96-6eb997a5887d",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Pipeline

Deletes the specified Pipeline.

Authorizations:
tokenAuth
path Parameters
pipelineId
required
string <uuid>
Example: f72521ba-1590-5998-bf96-6eb997a5887d

The ID (UUID) of the Pipeline.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

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

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:
tokenAuth
path Parameters
pipelineId
required
string <uuid>
Example: f72521ba-1590-5998-bf96-6eb997a5887d

The ID (UUID) of the Pipeline.

Request Body schema: application/json

Key to create.

object (KeyCreate)

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

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "key": "momSrlgAAEmaYEvBsMr^HsYn"
}