Getting Started with the Instana REST API
Welcome to the Instana REST API. This guide is designed to help you use the API to integrate with Instana's monitoring and observability platform.
Prerequisites
Before you start, make sure that you have:
- An Instana account.
- Basic understanding of RESTful APIs and HTTP protocols.
Authentication
To authenticate requests to the Instana REST API, you need an API token. Complete the following steps to generate your API token:
- Log in to Instana: Sign in to your Instana account.
- Go to Settings: Go to the Settings section of your Instana dashboard.
- Generate an API Token: Find the API Tokens section and generate a new token. Provide a name for your token and set the appropriate permissions.
- Copy the Token: After an API token is generated, copy your API token. Treat it securely, like a password.
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 theBearer
scheme.
Example by using cURL:
curl -X GET https://<TENANT>-<UNIT>.instana.io/api/<INSTANA_REST_API_ENDPOINT> \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
API endpoints
Explore the capabilities of the Instana REST API by using the API documentation. The documentation provides details on each endpoint, including request parameters, response formats, and example requests.
Rate limits
Make sure to 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.
Next steps
Now that you have an understanding of how to get started with the Instana REST API, explore the API documentation to use the full capabilities of Instana's monitoring and observability platform.