Instana API and SDKs

The Instana APIs allow you to integrate the Instana monitoring and observability platform into your applications.

For more information, see Instana REST API documentation and Instana GraphQL documentation.

Prerequisites

Before you begin, make sure that you have a basic understanding of RESTful APIs, GraphQL, HTTP protocols, and an Instana account.

Generating API token for authentication

To authenticate requests to the Instana APIs, you need an API token. Complete the following steps to generate your API token:

  1. Log on to your Instana account.
  2. From the navigation menu in the Instana UI, click Settings.
  3. On the Security & access tab, in the Access Control section, click API tokens .
  4. Enter a name for your token and set the appropriate permissions.
  5. After an API token is generated, copy your API token and keep it securely for future use.

Making requests

The Instana REST API and GraphQL API use standard HTTP methods. The base URL is unique to each Instana instance, is derived from your tenant and unit, and is the same URL you use to access the Instana user interface.

Use your API token to authenticate each request.

  • Base URL: https://<TENANT>-<UNIT>.instana.io/api
  • Authorization: Include your API token in the Authorization header by using the Bearer scheme.
The following example shows a request using curl: 
curl -X GET https://<TENANT>-<UNIT>.instana.io/api/<INSTANA_REST_API_ENDPOINT> \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
For GraphQL queries, all requests go to a single URL: 
POST https://<your-instana-host>/api/graphql

Replace <your-instana-host> with your Instana tenant hostname (for example, my-company.instana.io).

Every request is an HTTP POST with a JSON body contain the query you want to run.

API endpoints

An API endpoint is a specific URL that accepts requests for a particular operation. Instana provides endpoints that allow you to query monitoring data, configure alerting, and manage custom events.

For more information about the usage of Instana REST API and each endpoint, including request parameters, response formats, and example requests, see Instana REST API documentation.

GraphQL queries have a single endpoint, which is `api/graphql`. For more information about GraphQL queries, see Instana GraphQL documentation.

Rate limits

You must always review the rate limits for the Instana APIs. These limits help maintain service availability and performance for all users. For more information, seeInstana REST API rate limits.

Getting help

If you have questions or need assistance with integration and troubleshooting, see Instana Support.