Interact with the Telemetry Router API

When managing your STACKIT Telemetry Router instance programmatically, you interact with the Telemetry Router API.

We recommend using the STACKIT CLI to execute your requests. As explained in our Authentication Overview, the CLI automatically leverages your active session for authentication.

Universal API Wrapper (stackit curl)

To interact with the API, use the stackit curl wrapper. This command functions like a standard HTTP request but automatically handles authentication for you. To use it, you must provide the full API URL for your specific instance.

For a complete list of all available functions, endpoints, and configuration possibilities, refer to the STACKIT Telemetry Router API Specification.

General Syntax:

stackit curl -X <METHOD> "https://telemetry-router.api.stackit.cloud/v1/projects/<PROJECT_ID>/regions/<REGION_ID>/telemetry-routers/<TELEMETRY_ROUTER_ID>/<ENDPOINT>" \
  -H "Content-Type: application/json" \
  --data '<PAYLOAD>'

For comprehensive syntax details, refer to the official STACKIT CLI Curl Documentation .

---

Locating Your Identifiers

To execute API commands, you need your unique identifiers. Depending on the endpoint, this includes structural IDs (like Project or Organization IDs), the Region ID, and specific resource IDs (like the Router ID or Destination ID).

You can find all of these directly within the STACKIT Portal or by querying the API.

Project / Folder / Org ID

These are your foundational STACKIT identifiers. The Telemetry Router APIs mostly require the Project ID, but Telemetry Links can also be attached to Folders or Organizations.

1. In the STACKIT Portal, click the context switcher button located in the top navigation bar to open the Resource Manager.
2. Select the All Resources tab to view the complete hierarchy of your STACKIT organization.
3. Locate your specific Organization, Folder, or Project in the list.
4. Copy the ID directly from the ID column next to your chosen resource.

Region ID

The Region ID indicates the geographical location where your Telemetry Router is deployed.

Currently supported regions:

• eu01 (Germany)
• eu02 (Austria)

Where to find your active region:

• Top Navigation Bar: Check the location drop-down menu at the very top of the STACKIT Portal.

Router ID

This is the specific identifier for your Telemetry Router instance ($TELEMETRY_ROUTER_ID). You can retrieve it via the STACKIT Portal or the API.

Via STACKIT Portal:

1. Navigate to the left-hand navigation panel and select Telemetry Router.
2. Click on your specific router instance.
3. Under the Overview section on the left, copy the instance ID from the General Information panel.

Via API: Execute a list request to see all your instances and their IDs. For the exact API command, see List all instances.

Sub-Resource IDs

For specific operations (like editing or deleting a destination or access token), you need their exact ID (e.g., $ACCESS_TOKEN_ID or $DESTINATION_ID).

You can easily retrieve these IDs by using the STACKIT Portal or the API.

Via STACKIT Portal:

1. Navigate to the left-hand navigation panel and select Telemetry Router.
2. Click on your specific router instance.
3. On the instance sidebar, select Destinations or Access tokens.
4. Click on the specific entry you need the ID for.
5. Copy the ID from the detail view.

Via API: Execute a GET list request for the specific resource. The response payload will contain the unique IDs for each item. For the exact API commands, refer to our how-to guides:

• List all access tokens
• List all destinations