API

Use org API keys for automation, CI/CD, and scoped access.

Use organization API keys when you need non-interactive access from scripts, CI, or build systems.

Getting API keys

  1. Open traces.com/my-org/settings/api-keys
  2. Select Create API Key
  3. Choose a clear name and the minimum required scopes
  4. Copy the key immediately (shown once)

Keys begin with trk_.

Scopes available

ScopeWhat it allows
traces:writeUpload traces to the namespace
traces:readRead/list traces
namespace:readRead namespace metadata

What you can do with each scope

  • traces:write: traces share, CI uploads, automation that only publishes traces
  • traces:read: read/list traces from integrations
  • namespace:read: read org details for dashboards or tooling

For most CI pipelines that only upload traces, traces:write is enough.

Using keys

traces share --cwd . --key trk_your_api_key_here

or via environment variable:

export TRACES_API_KEY=trk_your_api_key_here
traces share --cwd .

GitHub Actions example:

env:
  TRACES_API_KEY: ${{ secrets.TRACES_API_KEY }}

Key management tips

  • Use one key per integration
  • Name keys by system/environment (for example: github-actions-main)
  • Rotate keys regularly
  • Revoke keys immediately if exposed
  • Keep keys in secrets managers, never in source control

Important limits

API keys are for trace and namespace API access, not membership or settings changes in the web app.

On this page