Instana Custom Dashboards API
You can use these API endpoints to manage custom dashboards. We recommendthat you leverage the `Edit as JSON` feature found within our user interfaceto construct the desired request payloads. Specifically to help you buildcorrect widget configurations and access rules.To identify the correct values for the `relatedId` field of the access rules,we recommend using the `/api/custom-dashboard/shareable-users` and`/api/custom-dashboard/shareable-api-tokens` endpoints. These endpoints returnour internal IDs for users and API tokens.
Instana Custom Dashboards API is one of 62 APIs that Instana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Custom Dashboards. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 7 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 1.307.1417.
Requests are made against 2 base URLs: https://{unit}-{tenant}.instana.io, https://{domain}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Instana Custom Dashboards API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as authorization (ApiKeyAuth).
ApiKeyAuth— Example bash curl --request GET \ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \ --header 'authorization: apiToken xxxxxxxx…
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
You can use these API endpoints to manage custom dashboards. We recommend that you leverage the Edit as JSON feature found within our user interface to construct the desired reque…
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Widget (8 properties), CustomDashboardWithUserSpecificInformation (6 properties), CustomDashboardPreview (4 properties), CustomDashboard (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Instana 12
Other APIs Instana publishes across the network.