API Reference

Complete API documentation for integrating Vultra into your applications.

Base URL

https://api.vultra.dev/v1

Authentication

API Key

All API requests require authentication using your API key in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Endpoints

Scans

POST /scans

Create Scan

Create a new security scan for your codebase.

curl -X POST https://api.vultra.dev/v1/scans \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "path": "./my-project",
    "language": "javascript",
    "options": {
      "severity": ["high", "medium"],
      "exclude": ["node_modules", "dist"]
    }
  }'

GET /scans/{scan_id}

Get Scan

Retrieve the results of a completed scan.

curl -X GET https://api.vultra.dev/v1/scans/scan_123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Webhooks

POST /webhooks

Create Webhook

Set up webhooks to receive real-time notifications about scan results.

curl -X POST https://api.vultra.dev/v1/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/vultra",
    "events": ["scan.completed", "vulnerability.found"],
    "secret": "your-webhook-secret"
  }'

Response Format

Standard Response

{
  "success": true,
  "data": {
    "id": "scan_123",
    "status": "completed",
    "vulnerabilities": [
      {
        "id": "vuln_456",
        "title": "SQL Injection",
        "severity": "high",
        "description": "Potential SQL injection vulnerability...",
        "file": "src/database.js",
        "line": 42,
        "cwe": "CWE-89"
      }
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "completed_at": "2024-01-15T10:35:00Z"
  },
  "meta": {
    "total_vulnerabilities": 5,
    "scan_duration": 300
  }
}

Error Handling

Error Response

{
  "success": false,
  "error": {
    "code": "invalid_api_key",
    "message": "The provided API key is invalid",
    "details": "Please check your API key and try again"
  }
}

Rate Limits

Free Tier

• 100 requests per hour
• 5 concurrent scans
• Basic vulnerability detection

Pro Tier

• 1000 requests per hour
• 20 concurrent scans
• Advanced AI detection

SDKs & Libraries

JavaScript

Official Node.js and browser SDK

Python

Python client library

CLI Tool

Command-line interface

Need Help?

Can't find what you're looking for? Our support team is here to help.

Contact Support View Examples