Getting Started with the Instana REST API

The Instana REST API allows you to integrate Instana's monitoring and observability platform into your applications.

Prerequisites

Before you begin, ensure that you have basic understanding of RESTful APIs and HTTP protocols, and an Instana account.

Generating API token for authentication

To authenticate requests to the Instana REST API, 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

Instana REST API uses standard HTTP methods. The base URL for the Instana REST API is specific to each Instana instance and is composed of the tenant and unit. The base URL is the same URL that is used 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 by using curl:

curl -X GET https://<TENANT>-<UNIT>.instana.io/api/<INSTANA_REST_API_ENDPOINT> \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

API endpoints

API endpoints of the Instana REST API refers to the different routes or paths that the API uses for various functions or operations. With these endpoints, you can interact with different aspects of the Instana platform, such as monitoring data management, alerting, and custom events. For more information about the usage of Instana REST API and each endpoint, including request parameters, response formats, and example requests, see API documentation.

Rate limits

You must always review the rate limits for the Instana REST API. These limits help maintain service availability and performance for all users.

Getting help

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