Documentation

API Keys

Learn how to create and manage API Keys in Verex for triggering test runs programmatically.

What are API Keys?

API Keys in Verex allow you to securely trigger and manage test runs via our public API. They are tied to your organization and act as authentication credentials for accessing API endpoints.

Creating an API Key

To create an API Key:

  1. Navigate to Settings > API Keys in the Verex dashboard.
  2. Click Generate New Key.
  3. Provide a name/label for the key (e.g., "CI Pipeline Key").
  4. Copy and store the key securely — you won't be able to view it again.

Using an API Key

When making API requests to trigger test runs, include the API Key in the headers:

Authorization: Bearer {YOUR_API_KEY}

You can use the API Key to:

  • Trigger Test Suites and individual Tests
  • Fetch Test Run and Test Suite Run results

Refer to Running Tests via API for complete details.

Using API Keys in Integrations

API Keys are also used in third-party and CI/CD pipeline integrations to authenticate test runs and access results. For example, you can:

  • Automate test execution on deployment
  • Track test suite results programmatically

To get started, visit the Integrations Overview page.

Best Practices

  • Create separate keys for different environments or use cases.
  • Rotate keys periodically for security.
  • Revoke any unused or compromised keys immediately.

Next Steps

On this page