API Keys¶
Account and Subscription Management
Account and Subscription management tasks are done only though IAPM Web
Subscription required
This section describes functionality which requires an active IAPM subscription. Start your subscription by choosing the plan right for you.
API keys authenticate your application's telemetry data with IAPM. Each grid has its own unique API key.
Getting Your API Key¶
- Go to your Grids page: azure.iapm.app or my.iapm.app
- Click the Instrument button () on your grid
- Copy your API key from the wizard
API Key Properties¶
| Property | Description |
|---|---|
| Scope | One API key per grid |
| Format | UUID string |
| Header | API-Key |
| Endpoint | https://otlp.iapm.app |
One API Key Per Application
Each application grid must have its own unique API key. Using the same key for multiple applications will mix telemetry data together, making it difficult to analyze.
Using Your API Key¶
Configure your OpenTelemetry exporter with your API key:
| Setting | Value |
|---|---|
| Endpoint | https://otlp.iapm.app |
| Header | API-Key: YOUR-API-KEY |
See Instrument Your Application for language-specific examples.
Security Best Practices¶
| Practice | Description |
|---|---|
| Don't commit to source control | Use environment variables or secrets management |
| Rotate periodically | Generate new keys if compromised |
| Use separate keys per environment | Different keys for dev, staging, production |
Regenerating API Keys¶
If an API key is compromised:
- Go to your grid settings
- Click Regenerate API Key
- Update your application configuration
- Deploy the change
Key Rotation
After regenerating, the old key is immediately invalidated. Update your applications promptly to avoid data loss.