Skip to main content
SOC Defenders uses API key authentication for all REST API requests. Every request you make must include a valid API key — requests without a key, or with an invalid or expired key, are rejected before reaching any endpoint. There are no session cookies or OAuth flows; the API key is the only credential you need.

​
Getting your API key

Sign in at socdefenders.ai, then navigate to Settings → API Keys. Click Create key, give it a name, and copy the key value immediately — it is only shown once. You can also reach the API Keys section from the export page. If you need to revoke a key, return to Settings → API Keys and delete it. The key stops working immediately.

​
Passing your key

The SOC Defenders API accepts your key in two request headers. Use whichever fits your tooling or integration. Option 1: Authorization header with Bearer scheme
Option 2: X-API-Key header
Both headers are equivalent. The Authorization: Bearer form is the standard HTTP convention and is the recommended default. Use X-API-Key if your infrastructure strips or rewrites the Authorization header.

​
API key security

Keep your API key secret. Do not commit it to source control, paste it into chat tools, or include it in client-side code or public repositories. If a key is exposed, rotate it immediately by deleting it in Settings → API Keys and creating a new one.
Treat your API key like a password. Recommended practices:
  • Store keys in environment variables or a secrets manager, not in code.
  • Use separate keys for different environments (development, staging, production).
  • Rotate keys periodically and immediately after any suspected exposure.
  • Grant keys only the access level your integration actually needs — use Free-tier keys for testing rather than production Pro keys.
If you believe a key has been compromised, contact security@socdefenders.ai in addition to rotating the key.

​
Authentication errors

When a request fails authentication, the API returns a 401 Unauthorized response with a JSON error body. For example, a request with a missing key returns:
Use the code field to identify the problem programmatically. The request_id is useful when contacting support.