API keys and ingest tokens

Osuite uses two credentials for different jobs:

• An ingest token authenticates telemetry arriving at your ingest endpoint. Your OpenTelemetry SDKs and Collectors send it with every batch of traces, logs, and metrics.
• An API key authenticates the Osuite CLI and AI agents against the Osuite API. It lets the CLI read telemetry and apply changes on your behalf.

Ingest tokens

Osuite creates one company ingest token while provisioning your telemetry environment. It travels in the x-osuite-ingest-token header of every request to your regional ingest endpoint:

https://ingest.<region>.osuite.io:443

After provisioning completes, admins can view the token under Integration or Settings → General. Members must ask an admin for it. The token grants write access to your company’s telemetry ingestion; it cannot read data or change settings.

Ingest-token rotation is not self-service. Contact support if a token may have been exposed or must be rotated. Coordinate the replacement across every SDK and Collector that uses the existing value.

API keys

A personal API key authenticates the Osuite CLI and AI agents against the regional API endpoint:

https://api.<region>.osuite.io

Create an API key inline under Integration or in Settings → Preferences. The raw key is shown only once. The CLI reads it from OSUITE_API_KEY; run osuite whoami to confirm it is valid and see which user it belongs to.

Caution

Treat ingest tokens and API keys as secrets. Do not commit them to source control or paste them into shared documents. Prefer environment variables and a secrets manager over hard-coded values.

Revoke an API key

Open Settings → Preferences to review and delete your personal API keys. Deletion takes effect immediately, so any CLI or agent using that key will stop authenticating.

Where each credential is used

Credential	Sent to	How	Used by
Ingest token	https://ingest.<region>.osuite.io:443	x-osuite-ingest-token header	OpenTelemetry SDKs and Collectors
API key	https://api.<region>.osuite.io	OSUITE_API_KEY environment variable	Osuite CLI and AI agents

Next steps

• Getting Started — send your first telemetry with an ingest token
• Set up the Osuite AI agents — authenticate the CLI with an API key
• Security and privacy — understand how ingest tokens are scoped