API Keys

API keys in the TestBeats portal provide secure authentication for integrating with the platform's services.

Scope

API keys are currently limited to publishing test results only.

• Publish test results.
• Upload attachments.

Usage

API keys are typically used in:

• CI/CD pipeline configurations
• Test framework integrations

Security

API keys should be treated as sensitive credentials and:

• Never committed to version control
• Stored securely in environment variables
• Rotated regularly for security

Best Practice

Store your API key in environment variables (e.g., TESTBEATS_API_KEY) rather than hardcoding them in your scripts or configuration files.

Next Steps

• Getting Started — first publish using your API key
• Environment variables — TESTBEATS_API_KEY and related options
• publish command — how the CLI uses the API key
• Service limits — credits and plan limits
• CI/CD integration — use keys from pipeline secrets