Skip to Content
DashboardAPI Keys

API Keys

API Keys enable programmatic access to Lamdis for CI/CD integrations, automation, and custom tooling.

Overview

API Keys provide:

  • Programmatic Access: Trigger test runs from CI/CD pipelines
  • Scoped Permissions: Control what each key can access
  • Audit Trail: Track API key usage in audit logs

Creating an API Key

  1. Navigate to Settings → API Keys
  2. Click Create API Key
  3. Configure the key:
    • Name: Descriptive name (e.g., “GitHub Actions CI”)
    • Permissions: Select allowed operations
    • Expiration: Optional expiration date
  4. Click Create
  5. Copy the key immediately - it won’t be shown again

API Key Permissions

PermissionDescription
runs:executeStart test runs
runs:readView run results
tests:readView test configurations
tests:writeCreate/modify tests
suites:readView suite configurations
suites:writeCreate/modify suites

Using API Keys

Authentication

Include the API key in the Authorization header:

curl https://api.lamdis.ai/v1/runs \ -H "Authorization: Bearer YOUR_API_KEY"

Triggering a Test Run

curl -X POST https://api.lamdis.ai/v1/runs \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "suiteId": "suite_abc123", "environmentId": "env_prod" }'

Getting Run Results

curl https://api.lamdis.ai/v1/runs/run_xyz789 \ -H "Authorization: Bearer YOUR_API_KEY"

Security Best Practices

  • Rotate keys regularly - Delete old keys and create new ones
  • Use minimal permissions - Only grant permissions the integration needs
  • Set expiration dates - For temporary integrations
  • Never commit keys to code - Use environment variables or secrets managers
  • Monitor usage - Review audit logs for unexpected activity

Revoking Keys

To revoke an API key:

  1. Go to Settings → API Keys
  2. Find the key to revoke
  3. Click Delete and confirm

Revoked keys stop working immediately.

Last updated on