API Keys

Generate API keys for programmatic access to Ops Atlas. Designed for CI/CD pipeline integration, API keys allow external tools to trigger deployments and query status without user credentials.

INFO

API Keys require a Pro license. See Licensing for details.

Access

Navigate to Settings > API Keys in the sidebar.

Key Features

• Generate long-lived API keys for CI/CD integration
• Each key has a description and optional expiration date
• Keys are shown once at creation — store them securely
• Revoke keys instantly when no longer needed
• API key usage is recorded in the Audit Log

Usage

Creating an API Key

1. Go to Settings > API Keys and click Generate Key
2. Enter a description (e.g. GitHub Actions - Production Deploys)
3. Optionally set an expiration date
4. Click Create
5. Copy the generated key immediately

WARNING

The API key value is only displayed once at creation time. If you lose it, you must generate a new key.

Using an API Key

Include the API key in the X-API-Key header on requests:

curl -H "X-API-Key: opatlas_k_abc123..." \
  https://ops-atlas.example.com/api/deployment/deploy \
  -X POST -H "Content-Type: application/json" \
  -d '{"environment": "qa", "service": "my-app", "tag": "v1.2.3"}'

API keys have the same permissions as the user who created them.

Managing Keys

The API keys list shows all active keys with:

• Description
• Created date
• Expiration date (if set)
• Last used timestamp

Click Revoke to immediately disable a key.

API

GET    /api/api-keys          # List all API keys
POST   /api/api-keys          # Generate a new key
DELETE /api/api-keys/{id}     # Revoke a key

Managed by ApiKeyController.