Back to Manual
📚api reference/ingestion api

ingestion api

the managed ingestion endpoint accepts standard opentelemetry (otlp/http) payloads.

  • protocol: otlp/http (protobuf or json)
  • endpoint: provided during key generation (e.g., https://api.iocane.ai/v1/traces).
  • data separation: every request is strictly scoped to an organization and environment.

api keys & authentication

iocane uses a secure, automated mechanism for api authentication:

  • auto-generation: ingest keys are automatically minted when you run iocane connect. you do not need to manually create or copy them. You can monitor the API keys generated, in your iocane profile page.
  • local storage: the cli securely writes the hashed key to your local environment configuration (e.g., .env or docker secrets).
  • mechanism: keys are environment-scoped tokens. they must be included in the x-iocane-key header of every ingest request.
  • lifecycle: keys can be rotated or revoked anytime via the cli. expires are enforced by organization policy.

managing keys

you can manage your api keys directly using the iocane cli.

  • expiration: by default, keys expire in 30 days. you can set a custom expiration during connection:

    bash
    iocane connect --expires-in 60
    # or set a specific date
    iocane connect --expires-at 2025-12-31
    
  • rotation: to rotate a key (e.g., if compromised or expiring):

    1. run iocane connect again in your environment.
    2. the cli will detect existing keys.
    3. press enter when prompted to generate a new key.
    4. the new key will be automatically saved to your local config (e.g., .env), replacing the old one.
  • generating new keys: if your environment has no active keys, running iocane connect will automatically generate a new one for you.