API Reference

Integrate Scault into your CI/CD pipeline, scripts, and tools.

Authentication

Include your API key in the Authorization header:

Authorization: Bearer sk_live_your_api_key

Generate API keys at Dashboard → Settings → API Keys

Quick Start — Run a Scan

curl -X POST https://scault.io/api/scan/execute \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -F "projectName=my-app" \
  -F "platforms=[\"linux\",\"macos\"]" \
  -F "scanTypes=[\"sast\",\"sca\",\"secrets\"]" \
  -F "file:src/app.ts=@./src/app.ts" \
  -F "file:package.json=@./package.json"

Response

{
  "scan": {
    "id": "scan-live-101",
    "projectName": "my-app",
    "status": "completed",
    "summary": {
      "total": 7,
      "critical": 1,
      "high": 2,
      "medium": 3,
      "low": 1,
      "info": 0
    },
    "findings": [
      {
        "id": "scan-live-101-f1",
        "scanType": "sast",
        "title": "SQL Injection via String Concatenation",
        "severity": "critical",
        "cwe": "CWE-89",
        "file": "src/app.ts",
        "line": 12,
        "recommendation": "Use parameterized queries..."
      }
    ]
  }
}

Authentication

POST/api/auth/loginAuthenticate and get session token

POST/api/auth/signupCreate a new account

GET/api/auth/sessionGet current session

Scans

POST/api/scan/executeUpload code and run a security scan

GET/api/scanList all scans

GET/api/scan/:idGet scan details and findings

GET/api/scan/:id/streamSSE stream for real-time scan progress

GET/api/scan/results/:idGet detailed scan results

Findings

GET/api/export?format=jsonExport all findings as JSON

GET/api/export?format=csvExport all findings as CSV

GET/api/export?severity=critical,highExport filtered findings

Badges

GET/api/badge?style=scoreSecurity score badge (SVG)

GET/api/badge?style=findingsFindings count badge

GET/api/badge?style=statusPass/fail status badge

GET/api/badge?style=criticalCritical findings badge

Webhooks

POST/api/webhooks/githubGitHub App webhook receiver

POST/api/webhooks/stripeStripe billing webhook receiver

Security Badges for your README

Add a security badge to your repository:

[![Scault Score](https://scault.io/api/badge?style=score)](https://scault.io/dashboard)

Rate Limits

Free Plan

60 req/hour

Pro Plan

1,000 req/hour

Enterprise

10,000 req/hour