API Key Management

Create, manage, and secure your long-lived API keys for server-side workflows and automated systems.

🔐

Secure Access

What Are API Keys?

API keys are cryptographic tokens used to authenticate server-to-server communication and automated systems. They provide long-lived access without requiring frequent refresh or user interaction.

When to Use

  • ✅
    Background services and workers
  • ✅
    Scheduled tasks
  • ✅
    Server-to-server APIs
  • ✅
    Internal services

When Not to Use

  • ❌
    Client-side web applications
  • ❌
    Mobile apps with direct exposure
  • ❌
    Publicly accessible tools

Managing API Keys

Generate New Key

  1. 1
    Open the developer console
  2. 2
    Navigate to API Keys section
  3. 3
    Click "Generate New Key"
  4. 4
    Copy the displayed key immediately
Generate Key

Security Best Practices

  • Store keys securely in environment variables
  • Rotate keys quarterly or after suspected compromise
  • Never share keys in public repositories

Integration Examples

cURL Secure Request 
curl -X POST 'https://api.dev.local/action' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json'
View Security Docs
JavaScript Async Request 
const apiKey = import.meta.env.VITE_API_KEY;
const response = await fetch('/api/data', {
  headers: {
    'X-API-Key': apiKey
  }
});
Config Reference

Related Documentation

Authentication Flow Security Best Practices
```