API How-Tos

The Monitoring Service offers regional APIs that enable programmatic interaction with the platform. These APIs serve various purposes: task automation, system integration, and platform functionality extension. Additionally, the APIs allow you to filter metrics based on different criteria.

Sub-user access control

A sub-user is a user who has access to the Monitoring Service but is not an administrator or an owner. IONOS's crucial access control restriction does not allow sub-users to view or modify pipelines belonging to other sub-user accounts, except the primary administrator, who retains full cross-pipeline privileges. Ensure that the sub-user pipeline ownership and access permissions align with your organizational needs.

If a sub-user account creates a pipeline, access is restricted only to that sub-user and the primary administrator. Other sub-users cannot access or perform CRUD operations on the respective pipeline. For example, if sub-user A creates Pipeline 1, only sub-user A and the primary administrator account can view, edit, delete, or manage Pipeline 1. No other sub-user accounts will have access to it.

Regional REST API endpoint

A regional endpoint is necessary to interact with the Monitoring Service REST API endpoints. Currently, IONOS supports only the following regions for the Monitoring Service:

• Berlin: https://monitoring.de-txl.ionos.com/pipelines

• Frankfurt: https://monitoring.de-fra.ionos.com/pipelines

• London: https://monitoring.gb-lhr.ionos.com/pipelines

• Paris: https://monitoring.fr-par.ionos.com/pipelines

• Logroño: https://monitoring.es-vit.ionos.com/pipelines

Note: We recommend using the authorized IP addresses associated with each endpoint if you need to configure firewall rules to restrict traffic sent to the Monitoring Service endpoints. It enables you to configure rules accordingly to ensure traffic is redirected only through authorized IP addresses for each endpoint. For more information about the authorized IP addresses, see FAQs.

Request parameter headers

To interact with the Monitoring Service REST API endpoints, the header must contain the following values:

Header	Required	Type	Description
Authorization	yes	string	A Bearer $TOKEN is a string that is tied to your account. For information on generating tokens, see Create New Tokens.
Content-Type	yes	string	Set this to application/json.

Quick Links

Here are some of the most common API How-Tos for the Monitoring Service:

Create a Monitoring Pipeline Instancee	Create an instance of a monitoring pipeline.
Obtain a new Key	Obtain a new key for a monitoring pipeline.
Modify a Monitoring Pipeline Instance	Update an existing monitoring pipeline.
Retrieve a Monitoring Pipeline	Retrieve information about a specific monitoring pipeline.
Retrieve All Monitoring Pipelinese	Retrieve all monitoring pipelines.
Delete a Monitoring Pipeline Instance	Delete a specific monitoring pipeline.

We recommend you refer to the following after creating an instance via the API:

Send Metrics to the Platform
Access Metrics from the Platform