STACKIT

STACKIT Observability API

API endpoints for Observability on STACKIT

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API endpoints for Observability on STACKIT

Endpoints 106

  • GETListInstances/v1/projects/:projectId/instancesGet all instances for a project.
  • POSTCreateInstance/v1/projects/:projectId/instancesCreate new instance.
  • GETGetInstance/v1/projects/:projectId/instances/:instanceIdGet instance information.
  • PUTUpdateInstance/v1/projects/:projectId/instances/:instanceIdUpdate instance.
  • DELETEDeleteInstance/v1/projects/:projectId/instances/:instanceIdDelete instance.
  • GETListACL/v1/projects/:projectId/instances/:instanceId/aclGet acl for instance.
  • PUTUpdateACL/v1/projects/:projectId/instances/:instanceId/aclUpdate acl config.
  • GETGetAlertConfigs/v1/projects/:projectId/instances/:instanceId/alertconfigsGet alert config.
  • PUTUpdateAlertConfigs/v1/projects/:projectId/instances/:instanceId/alertconfigsUpdate alert config.
  • GETListAlertConfigReceivers/v1/projects/:projectId/instances/:instanceId/alertconfigs/receiversGet alert config receivers.
  • POSTCreateAlertConfigReceiver/v1/projects/:projectId/instances/:instanceId/alertconfigs/receiversCreate alert config receiver.
  • GETGetAlertConfigReceiver/v1/projects/:projectId/instances/:instanceId/alertconfigs/receivers/:receiverGet alert config receivers.
  • PUTUpdateAlertConfigReceiver/v1/projects/:projectId/instances/:instanceId/alertconfigs/receivers/:receiverUpdate alert config receiver.
  • DELETEDeleteAlertConfigReceiver/v1/projects/:projectId/instances/:instanceId/alertconfigs/receivers/:receiverDelete alert config receiver.
  • GETListAlertConfigRoutes/v1/projects/:projectId/instances/:instanceId/alertconfigs/routesGet alert config route.
  • POSTCreateAlertConfigRoute/v1/projects/:projectId/instances/:instanceId/alertconfigs/routesCreate alert config route in routes of route.
  • GETGetAlertConfigRoute/v1/projects/:projectId/instances/:instanceId/alertconfigs/routes/:receiverGet alert receiver for route.
  • PUTUpdateAlertConfigRoute/v1/projects/:projectId/instances/:instanceId/alertconfigs/routes/:receiverUpdate alert receiver for route.
  • DELETEDeleteAlertConfigRoute/v1/projects/:projectId/instances/:instanceId/alertconfigs/routes/:receiverDelete alert receiver for route.
  • GETListAlertgroups/v1/projects/:projectId/instances/:instanceId/alertgroupsGet alert groups.
  • PUTUpdateAlertgroups/v1/projects/:projectId/instances/:instanceId/alertgroupsUpdate alert groups.
  • POSTCreateAlertgroups/v1/projects/:projectId/instances/:instanceId/alertgroupsCreate alert group.
  • DELETEDeleteAlertgroups/v1/projects/:projectId/instances/:instanceId/alertgroups?groupName=stringDelete alert groups.
  • PATCHPartialUpdateAlertgroups/v1/projects/:projectId/instances/:instanceId/alertgroupsPatch alert groups.
  • GETGetAlertgroup/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupNameGet alert group.
  • PUTUpdateAlertgroup/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupNameUpdate alert group config.
  • DELETEDeleteAlertgroup/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupNameDelete alert group config.
  • GETListAlertrules/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/alertrulesGet alert rules.
  • POSTCreateAlertrules/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/alertrulesCreate alert rule.
  • DELETEDeleteAlertrules/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/alertrules?alertName=stringDelete alert rules.
  • PATCHPartialUpdateAlertrules/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/alertrulesPatch alert rules.
  • GETGetAlertrule/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/alertrules/:alertNameGet alert rule.
  • PUTUpdateAlertrule/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/alertrules/:alertNameUpdate alert rule.
  • DELETEDeleteAlertrule/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/alertrules/:alertNameDelete alert rule.
  • GETListAlertRecords/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/recordsGet alert records.
  • POSTCreateAlertRecord/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/recordsCreate alert record.
  • DELETEDeleteAlertRecords/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/records?alertRecord=stringDelete alert records.
  • PATCHPartialUpdateAlertRecords/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/recordsPatch alert records.
  • GETGetAlertRecord/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/records/:alertRecordGet alert record.
  • PUTUpdateAlertRecord/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/records/:alertRecordUpdate alert record.
  • DELETEDeleteAlertRecord/v1/projects/:projectId/instances/:instanceId/alertgroups/:groupName/records/:alertRecordDelete alert record.
  • POSTRestoreBackup/v1/projects/:projectId/instances/:instanceId/backup-restores/:backupDate?restoreTarget=alertConfigRestore backup.
  • GETListBackupRetentions/v1/projects/:projectId/instances/:instanceId/backup-retentionsGet backup retention.
  • GETListBackupSchedules/v1/projects/:projectId/instances/:instanceId/backup-schedulesGet backup schedules.
  • POSTCreateBackupSchedule/v1/projects/:projectId/instances/:instanceId/backup-schedulesCreate backup schedule.
  • GETListBackups/v1/projects/:projectId/instances/:instanceId/backupsGet backups.
  • POSTCreateBackup/v1/projects/:projectId/instances/:instanceId/backupsCreate a backup.
  • GETListCertChecks/v1/projects/:projectId/instances/:instanceId/cert-checksGet all cert checks configured.
  • POSTCreateCertCheck/v1/projects/:projectId/instances/:instanceId/cert-checksCreate cert check.
  • DELETEDeleteCertCheck/v1/projects/:projectId/instances/:instanceId/cert-checks/:idDelete cert check.
  • GETListCredentials/v1/projects/:projectId/instances/:instanceId/credentialsGet all technical user credentials.
  • POSTCreateCredentials/v1/projects/:projectId/instances/:instanceId/credentialsCreate technical user credentials.
  • GETGetCredentials/v1/projects/:projectId/instances/:instanceId/credentials/:usernameGet single technical credentials.
  • DELETEDeleteCredentials/v1/projects/:projectId/instances/:instanceId/credentials/:usernameDelete technical credentials.
  • GETGetCredentialsRemoteWriteConfig/v1/projects/:projectId/instances/:instanceId/credentials/:username/remote-write-limitsGet remote write config.
  • PUTUpdateCredentialsRemoteWriteConfig/v1/projects/:projectId/instances/:instanceId/credentials/:username/remote-write-limitsUpdate remote write config for credentials.
  • DELETEDeleteCredentialsRemoteWriteConfig/v1/projects/:projectId/instances/:instanceId/credentials/:username/remote-write-limitsDelete remote write config for credentials.
  • GETListElasticsearchChecks/v1/projects/:projectId/instances/:instanceId/elasticsearch-checksGet all elasticsearch checks configured.
  • POSTCreateElasticsearchCheck/v1/projects/:projectId/instances/:instanceId/elasticsearch-checksCreate elasticsearch check.
  • DELETEDeleteElasticsearchCheck/v1/projects/:projectId/instances/:instanceId/elasticsearch-checks/:idDelete elasticsearch check.
  • GETGetGrafanaConfigs/v1/projects/:projectId/instances/:instanceId/grafana-configsGet grafana config.
  • PUTUpdateGrafanaConfigs/v1/projects/:projectId/instances/:instanceId/grafana-configsUpdate grafana config.
  • GETListHttpChecks/v1/projects/:projectId/instances/:instanceId/http-checksGet all http checks configured.
  • POSTCreateHttpCheck/v1/projects/:projectId/instances/:instanceId/http-checksCreate http check.
  • DELETEDeleteHttpCheck/v1/projects/:projectId/instances/:instanceId/http-checks/:idDelete http check.
  • GETListLogsAlertgroups/v1/projects/:projectId/instances/:instanceId/logs-alertgroupsGet logs alert groups config.
  • POSTCreateLogsAlertgroups/v1/projects/:projectId/instances/:instanceId/logs-alertgroupsCreate logs alert group config.
  • GETGetLogsAlertgroup/v1/projects/:projectId/instances/:instanceId/logs-alertgroups/:groupNameGet logs alert group config.
  • PUTUpdateLogsAlertgroup/v1/projects/:projectId/instances/:instanceId/logs-alertgroups/:groupNameUpdate logs alert group config.
  • DELETEDeleteLogsAlertgroup/v1/projects/:projectId/instances/:instanceId/logs-alertgroups/:groupNameDelete logs alert group config.
  • GETGetLogsConfigs/v1/projects/:projectId/instances/:instanceId/logs-configsGet logs configuration.
  • PUTUpdateLogsConfigs/v1/projects/:projectId/instances/:instanceId/logs-configsUpdate logs config.
  • GETGetMetricsStorageRetention/v1/projects/:projectId/instances/:instanceId/metrics-storage-retentionsGet metric storage retention time.
  • PUTUpdateMetricsStorageRetention/v1/projects/:projectId/instances/:instanceId/metrics-storage-retentionsUpdate metric update retention time.
  • GETListMongodbChecks/v1/projects/:projectId/instances/:instanceId/mongodb-checksGet all mongodb checks configured.
  • POSTCreateMongodbCheck/v1/projects/:projectId/instances/:instanceId/mongodb-checksCreate mongodb check.
  • DELETEDeleteMongodbCheck/v1/projects/:projectId/instances/:instanceId/mongodb-checks/:idDelete mongodb check.
  • GETListMysqlChecks/v1/projects/:projectId/instances/:instanceId/mysql-checksGet all mysql checks configured.
  • POSTCreateMysqlCheck/v1/projects/:projectId/instances/:instanceId/mysql-checksCreate mysql check.
  • DELETEDeleteMysqlCheck/v1/projects/:projectId/instances/:instanceId/mysql-checks/:idDelete mysql check.
  • GETListNetworkChecks/v1/projects/:projectId/instances/:instanceId/network-checksGet all network checks configured.
  • POSTCreateNetworkCheck/v1/projects/:projectId/instances/:instanceId/network-checksCreate network check.
  • DELETEDeleteNetworkCheck/v1/projects/:projectId/instances/:instanceId/network-checks/:idDelete network check.
  • GETListPingChecks/v1/projects/:projectId/instances/:instanceId/ping-checksGet all ping checks configured.
  • POSTCreatePingCheck/v1/projects/:projectId/instances/:instanceId/ping-checksCreate ping check.
  • DELETEDeletePingCheck/v1/projects/:projectId/instances/:instanceId/ping-checks/:idDelete ping check.
  • GETListPostgresqlChecks/v1/projects/:projectId/instances/:instanceId/postgresql-checksGet all postgresql checks configured.
  • POSTCreatePostgresqlCheck/v1/projects/:projectId/instances/:instanceId/postgresql-checksCreate postgresql check.
  • DELETEDeletePostgresqlCheck/v1/projects/:projectId/instances/:instanceId/postgresql-checks/:idDelete postgresql check.
  • GETListRabbitmqChecks/v1/projects/:projectId/instances/:instanceId/rabbitmq-checksGet all rabbitmq checks configured.
  • POSTCreateRabbitmqCheck/v1/projects/:projectId/instances/:instanceId/rabbitmq-checksCreate rabbitmq check.
  • DELETEDeleteRabbitmqCheck/v1/projects/:projectId/instances/:instanceId/rabbitmq-checks/:idDelete rabbitmq check.
  • GETListRedisChecks/v1/projects/:projectId/instances/:instanceId/redis-checksGet all redis checks configured.
  • POSTCreateRedisCheck/v1/projects/:projectId/instances/:instanceId/redis-checksCreate redis check.
  • DELETEDeleteRedisCheck/v1/projects/:projectId/instances/:instanceId/redis-checks/:idDelete redis check.
  • GETListScrapeConfigs/v1/projects/:projectId/instances/:instanceId/scrapeconfigsGet scrape configs.
  • POSTCreateScrapeConfig/v1/projects/:projectId/instances/:instanceId/scrapeconfigsCreate scrape config.
  • DELETEDeleteScrapeConfigs/v1/projects/:projectId/instances/:instanceId/scrapeconfigs?jobName=stringDelete scrape configs.
  • PATCHPartialUpdateScrapeConfigs/v1/projects/:projectId/instances/:instanceId/scrapeconfigsUpdate scrape configs.
  • GETGetScrapeConfig/v1/projects/:projectId/instances/:instanceId/scrapeconfigs/:jobNameGet scrape config.
  • PUTUpdateScrapeConfig/v1/projects/:projectId/instances/:instanceId/scrapeconfigs/:jobNameUpdate scrape config.
  • DELETEDeleteScrapeConfig/v1/projects/:projectId/instances/:instanceId/scrapeconfigs/:jobNameDelete scrape config.
  • GETGetTracesConfigs/v1/projects/:projectId/instances/:instanceId/traces-configsGet traces config.
  • PUTUpdateTracesConfigs/v1/projects/:projectId/instances/:instanceId/traces-configsUpdate traces config.
  • GETListOfferings/v1/projects/:projectId/offeringsGet all plans.
  • GETListPlans/v1/projects/:projectId/plansGet all plans.

API details

Base URL
https://argus.api.{region}stackit.cloud
Authentication
None declared in the description
Operations
106 operations on 51 pathsGET 40DELETE 24POST 22PUT 16PATCH 4
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.1.1

How to test the STACKIT Observability API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the STACKIT Observability API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “ListInstances” (GET /v1/projects/:projectId/instances), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the STACKIT Observability API?

API endpoints for Observability on STACKIT It is listed under Developer tools and has 106 endpoints.

Who publishes the STACKIT Observability API?

It is listed from STACKIT's public API description (an OpenAPI document), not published by STACKIT on Swastik Codes. Anyone who controls stackit.cloud can claim the profile by adding a DNS TXT record.

What is the base URL of the STACKIT Observability API?

Requests go to https://argus.api.{region}stackit.cloud. Endpoint paths are added to this base URL.

How do I authenticate with the STACKIT Observability API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the STACKIT Observability API have?

106 operations on 51 paths (40 GET, 24 DELETE, 22 POST, 16 PUT, 4 PATCH).

Is forking the STACKIT Observability API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.