API Reference

All API endpoints are served under:

https://cspwarden.com/api/v1/

Include your API key in every request:

curl -H "Authorization: Api-Key YOUR_API_KEY" \
  https://cspwarden.com/api/v1/domains/

Or in your application code:

import requests

headers = {
    "Authorization": "Api-Key cspw_live_a1b2c3d4e5f6..."
}

response = requests.get(
    "https://cspwarden.com/api/v1/domains/",
    headers=headers
)
print(response.json())

const response = await fetch("https://cspwarden.com/api/v1/domains/", {
  headers: {
    "Authorization": "Api-Key cspw_live_a1b2c3d4e5f6..."
  }
});
const data = await response.json();

CSP Warden supports two types of API keys, both disabled by default and available only on Business and Enterprise plans.

Generating API Keys

1. Navigate to Settings → API Access in your dashboard.
2. Enable global API access for your account.
3. Click Generate API Key to create a global key.
4. For domain-scoped keys, go to the specific domain's settings and enable API access there, then generate a domain key.

API requests are rate-limited per key. Current limits by plan:

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

The API returns standard HTTP status codes and JSON error bodies:

{
  "detail": "Authentication credentials were not provided."
}

List endpoints return paginated results. Pass page as a query parameter. Each page returns up to 50 items by default.

{
  "count": 142,
  "next": "https://cspwarden.com/api/v1/violations/?page=2",
  "previous": null,
  "results": [ ... ]
}