Skip to main content

API Keys

All API requests require authentication via API key.

Creating an API Key

  1. Go to Settings → API Keys
  2. Click Create API Key
  3. Name your key (e.g., “GitHub Actions”, “Jenkins”)
  4. Copy the key immediately (only shown once)
  5. Store securely in your environment

Using API Keys

Request Header

Include your API key in the Authorization header:

Example Request

Environment Variables

Store API keys as environment variables:

Bash

GitHub Actions

Python

Security Best Practices

✅ Do

  • Store keys in environment variables or secret managers
  • Use different keys for different environments (dev, staging, prod)
  • Rotate keys regularly
  • Delete unused keys

❌ Don’t

  • Commit keys to version control
  • Share keys in plaintext (Slack, email)
  • Use the same key across multiple projects
  • Log or print keys in application code

Key Management

Rotating Keys

  1. Create new API key
  2. Update environment variables in CI/CD
  3. Test with new key
  4. Delete old key

Deleting Keys

  1. Go to Settings → API Keys
  2. Click Delete on the key
  3. Confirm deletion
  4. Update any services using that key

Error Responses

Invalid Key

Status: 401 Unauthorized

Missing Key

Status: 401 Unauthorized

Expired Key

Status: 401 Unauthorized