Authentication

All API requests require authentication using an API key. Keys are passed in the Authorization header using the Bearer scheme.

API Key Format

Each API key is a unique, cryptographically secure token. Include it in the Authorization header:

API keys are hashed in our database and cannot be recovered. Keep them secure and regenerate them if you suspect exposure.

Making Authenticated Requests

Include your API key in the Authorization header:

curl https://deadlinkradar.com/api/v1/account \
  -H "Authorization: Bearer dlr_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"

Creating API Keys

From the Dashboard

The easiest way to create an API key is from your Dashboard:

1. Go to Settings → API
2. Click Create API Key
3. Enter a name (e.g., "Production Key")
4. Copy the key immediately - it won't be shown again

Via the API

You can also create keys programmatically using an existing key:

curl -X POST https://deadlinkradar.com/api/v1/keys \
  -H "Authorization: Bearer dlr_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Key",
    "permissions": {
      "read": true,
      "write": true
    }
  }'

Permissions

API keys have two permission types that control access:

By default, new keys have both permissions enabled. Use read-only keys for monitoring dashboards or public integrations.

Authentication Errors

When authentication fails, you'll receive one of these error responses:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid authorization header",
    "status": 401
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid",
    "status": 401
  }
}

{
  "error": {
    "code": "EXPIRED_API_KEY",
    "message": "The provided API key has expired",
    "status": 401
  }
}

Security Best Practices