Create and manage instances of Telemetry Router

Prerequisites

• You have a STACKIT customer account: Create a customer account
• You have a STACKIT user account: Create a user account
• You have a STACKIT project: Create a project

The Telemetry Router is a self-manageable component through which telemetry data can be introduced. In order to ingest data at the Telemetry Router endpoint, an individually creatable access token is required. Creating a Telemetry Router enables the setup of destinations, filtering, and emission of the captured data.

API Prerequisites & Variables

To execute the API commands in this guide, you must first export the following path parameters as environment variables in your terminal (or replace them directly in the commands):

• $PROJECT_ID: Your unique STACKIT project ID (e.g., 16dbfb51...).
• $REGION_ID: The region where your instance will be located (e.g., eu01 or eu02).
• $TELEMETRY_ROUTER_ID: The unique ID of your Telemetry Router instance (required for View, Edit, and Delete operations).

If you need help locating these identifiers or want to learn how the stackit curl wrapper works, refer to our central guide: Interacting with the Telemetry Router API.

For a conceptual overview of the different authentication paths, see our Authentication Overview.

Create an instance

STACKIT API

To create a Telemetry Router instance, you need to call the appropriate endpoint.

Choose the properties for your new instance

Parameter	Meaning	Example
displayName	A name for the Telemetry Router instance	my-telemetry-router
description	An optional description for your reference	My Telemetry Router instance

stackit curl -X POST \
"https://telemetry-router.api.stackit.cloud/v1/projects/$PROJECT_ID/regions/$REGION_ID/telemetry-routers" \
-H "Content-Type: application/json" \
--data '{
    "displayName": "<DISPLAY_NAME>",
    "description": "<DESCRIPTION>"
}'

Example

stackit curl -X POST \
"https://telemetry-router.api.stackit.cloud/v1/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers" \
-H "Content-Type: application/json" \
--data '{
    "displayName": "my-telemetry-router",
    "description": "My Telemetry Router instance"
}'

STACKIT Portal

Follow the steps in the Portal to create a Telemetry Router instance.

1. On the sidebar, click on Telemetry Router.

2. On the bar on the top, click on Create Telemetry Router.

3. On the pane fill in a Router name.

4. After you configured everything to your needs, create your instance.

   The system will add your newly created instance to the list of your Telemetry Router instances. After a few seconds, your instance state changes from Reconciling to Active. Congratulations, your Telemetry Router instance is up and running!

List all instances

STACKIT API

stackit curl -X GET \
"https://telemetry-router.api.stackit.cloud/v1/projects/$PROJECT_ID/regions/$REGION_ID/telemetry-routers" \
-H "Content-Type: application/json"

Example

stackit curl -X GET \
"https://telemetry-router.api.stackit.cloud/v1/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers" \
-H "Content-Type: application/json"

STACKIT Portal

Follow the steps in the Portal to create a Telemetry Router instance.

1. On the sidebar, click on Telemetry Router.

   You see a list of all Telemetry Router instances.

View an instance

STACKIT API

stackit curl -X GET \
"https://telemetry-router.api.stackit.cloud/v1/projects/$PROJECT_ID/regions/$REGION_ID/telemetry-routers/$TELEMETRY_ROUTER_ID" \
-H "Content-Type: application/json"

Example

stackit curl -X GET \
"https://telemetry-router.api.stackit.cloud/v1/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557" \
-H "Content-Type: application/json"

STACKIT Portal

Follow the steps in the Portal to create a Telemetry Router instance.

1. On the sidebar, click on Telemetry Router.

   You see a list of all Telemetry Router instances.

2. Navigate to the instance you want to view and click on the entry.

   You get into the detail view of your instance, where you have an overview over all properties.

Edit an instance

STACKIT API

Parameter	Meaning	Example
displayName	A name for the Telemetry Router instance. In this endpoint, the parameter is optional.	my-telemetry-router
description	An optional description for your reference	My Telemetry Router instance
filter	An optional filter object. Read Filter to learn how filters work.	See Filter example

stackit curl -X PUT \
"https://telemetry-router.api.stackit.cloud/v1/projects/$PROJECT_ID/regions/$REGION_ID/telemetry-routers/$TELEMETRY_ROUTER_ID" \
-H "Content-Type: application/json" \
--data '{
    "displayName": "<DISPLAY_NAME>",
    "description": "<DESCRIPTION>",
    "filter": <FILTER_OBJECT>
}'

Filter example

"attributes": [
    {
        "key": "my-special-filter",
        "level": "scope",
        "matcher": "=",
        "value": "user"
    }
]

Example of adding a filter to an existing Telemetry Router instance

stackit curl -X PUT \
"https://telemetry-router.api.stackit.cloud/v1/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557" \
-H "Content-Type: application/json" \
--data '{
    "filter": {
        "attributes": [
            {
                "key": "my-special-filter",
                "level": "scope",
                "matcher": "=",
                "value": "user"
            }
        ]
    }
}'

STACKIT Portal

Follow the steps in the Portal to create a Telemetry Router instance.

1. On the sidebar, click on Telemetry Router.

   You see a list of all Telemetry Router instances.

2. Navigate to the instance you want to view and click on the entry.

   You get into the detail view of your instance, where you have an overview over all properties.

3. To change the name or the description of your instance, click on Edit next to General information. Do the same for editing Attribute filters.

Delete an instance

STACKIT API

To delete a Telemetry Router instance, you need to call the DELETE endpoint.

stackit curl -X DELETE \
"https://telemetry-router.api.stackit.cloud/v1/projects/$PROJECT_ID/regions/$REGION_ID/telemetry-routers/$TELEMETRY_ROUTER_ID" \
-H "Content-Type: application/json"

Example:

stackit curl -X DELETE \
"https://telemetry-router.api.stackit.cloud/v1/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557" \
-H "Content-Type: application/json"

STACKIT Portal

Follow the steps in the Portal to create a Telemetry Router instance.

1. On the sidebar, click on Telemetry Router.

   You see a list of all Telemetry Router instances.

2. Navigate to the instance you want to delete and open the three-dots-menu of the entry.

3. On the menu click on Delete.

4. On the new pane, enter your instances name and click on delete.