Create and manage instances

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

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
accessToken	The individual access token of your service account	`eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4`
projectId	Your individual project ID	`16dbfb51-7a75-42d3-a51d-99f87f48cd32`
regionId	The region your Telemetry Router instance is located	`eu01`
displayName	A name for the Telemetry Router instance	`my-telemetry-router`
description	An optional description for your reference	`My Telemetry Router instance`

curl  -X POST \
'https://telemetry-router.api.[regionId].stackit.cloud/v1alpha/projects/[projectId]/regions/[regionId]/telemetry-routers' \
--header 'Authorization: Bearer [accessToken]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "displayName": [displayName],
    "description": [description]
}'

Example

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

List all instances

STACKIT API

Parameter	Meaning	Example
accessToken	The individual access token of your service account	`eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4`
projectId	Your individual project ID	`16dbfb51-7a75-42d3-a51d-99f87f48cd32`
regionId	The region your Telemetry Router instance is located	`eu01`

curl  -X GET \
'https://telemetry-router.api.[regionId].stackit.cloud/v1alpha/projects/[projectId]/regions/[regionId]/telemetry-routers' \
--header 'Authorization: Bearer [accessToken]' \
--header 'Content-Type: application/json'

Example

curl  -X GET \
'https://telemetry-router.api.eu01.stackit.cloud/v1alpha/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers' \
--header 'Authorization: Bearer [accessToken]' \
--header 'Content-Type: application/json'

View an instance

STACKIT API

Parameter	Meaning	Example
accessToken	The individual access token of your service account	`eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4`
projectId	Your individual project ID	`16dbfb51-7a75-42d3-a51d-99f87f48cd32`
regionId	The region your Telemetry Router instance is located	`eu01`
telemetryRouterId	The ID of your Telemetry Router instance	`d5b5cdcc-c155-4d66-82ef-4289db8e4557`

curl  -X GET \
'https://telemetry-router.api.[regionId].stackit.cloud/v1alpha/projects/[projectId]/regions/[regionId]/telemetry-routers/[telemetryRouterId]' \
--header 'Authorization: Bearer [accessToken]' \
--header 'Content-Type: application/json'

Example

curl  -X GET \
'https://telemetry-router.api.eu01.stackit.cloud/v1alpha/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557' \
--header 'Authorization: Bearer [accessToken]' \
--header 'Content-Type: application/json'

Edit an instance

STACKIT API

Parameter	Meaning	Example
accessToken	The individual access token of your service account	`eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4`
projectId	Your individual project ID	`16dbfb51-7a75-42d3-a51d-99f87f48cd32`
regionId	The region your Telemetry Router instance is located	`eu01`
telemetryRouterId	The ID of your Telemetry Router instance	`d5b5cdcc-c155-4d66-82ef-4289db8e4557`
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

curl  -X PUT \
'https://telemetry-router.api.[regionId].stackit.cloud/v1alpha/projects/[projectId]/regions/[regionId]/telemetry-routers/[telemetryRouterId]' \
--header 'Authorization: Bearer [accessToken]' \
--header 'Content-Type: application/json'
--data-raw '{
    "displayName": [name],
    "description": [description],
    "filter": [filter]
}'

Filter example

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

Example of adding a filter to an existing Telemetry Router instance

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

Delete an instance

STACKIT API

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

Parameter	Meaning	Example
accessToken	The individual access token of your service account	`eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4`
projectId	Your individual project ID	`16dbfb51-7a75-42d3-a51d-99f87f48cd32`
regionId	The region your Telemetry Router instance is located	`eu01`
telemetryRouterId	The ID of your Telemetry Router instance	`d5b5cdcc-c155-4d66-82ef-4289db8e4557`

curl  -X DELETE \
'https://telemetry-router.api.[regionId].stackit.cloud/v1alpha/projects/[projectId]/regions/[regionId]/telemetry-routers/[telemetryRouterId]' \
--header 'Authorization: Bearer [accessToken]' \
--header 'Content-Type: application/json' \

Example:

curl  -X DELETE \
'https://telemetry-router.api.eu01.stackit.cloud/v1alpha/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557' \
--header 'Authorization: Bearer eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4' \
--header 'Content-Type: application/json' \