Skip to main content

API Documentation

Integrate ClawDefend into your CI/CD pipeline. Requires Developer plan.

Authentication

Include your API key in the Authorization header:

Authorization: Bearer sk_live_your_api_key_here
POST/api/v1/scan

Submit a new scan. Provide a GitHub URL or upload files.

Request Body

{
  "source_type": "github_url",
  "source_url": "https://github.com/user/skill-repo"
}

Response

{
  "scan_id": "scan-abc123",
  "status": "pending",
  "created_at": "2026-02-10T15:30:00Z"
}
GET/api/v1/scan/:id

Get scan results by ID.

Response

{
  "id": "scan-abc123",
  "status": "complete",
  "overall_score": 23,
  "severity": "critical",
  "findings": [...]
}
GET/api/v1/skills

Search the verified skill directory.

Response

{
  "skills": [...],
  "total": 186,
  "page": 1,
  "per_page": 20
}
POST/api/v1/webhooks

Register a webhook for scan completion notifications.

Request Body

{
  "url": "https://your-server.com/webhook",
  "events": ["scan.complete"]
}

Response

{
  "id": "wh-xyz789",
  "url": "https://your-server.com/webhook",
  "events": ["scan.complete"],
  "active": true
}