🔧Developer-First API

API Reference

Integrate VibeGuard's security platform into your applications with our comprehensive REST API. Manage scans, retrieve findings, configure policies, and automate security workflows programmatically.

Get Started with API Quick Start Guide

200+

API Endpoints

99.9%

API Uptime

<100ms

Average Response Time

Getting Started

Everything you need to start using the VibeGuard API

Authentication

VibeGuard API uses API keys for authentication. All API requests must include your API key in the Authorization header.

# Generate API Key

curl -X POST https://api.vibeguard.com/v1/auth/tokens \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# Use API Key in requests

curl -H "Authorization: Bearer vg_api_key_123abc..." \
https://api.vibeguard.com/v1/scans

Get your API key

Navigate to Settings → API Keys in your dashboard

Include in headers

Add "Authorization: Bearer YOUR_API_KEY" to all requests

Make requests

Use HTTPS for all API requests to api.vibeguard.com

Base URL & Versioning

All API endpoints are versioned and accessed through our base URL. We maintain backward compatibility and provide migration guides for major version changes.

Base URL: https://api.vibeguard.com

Current Version: v1

Content Type: application/json

Rate Limits: 1000 requests/hour

💡

API Playground

Use our interactive API explorer at api.vibeguard.com/playground to test endpoints and see live responses.

Core API Endpoints

Essential endpoints for scanning, findings, and security management

Scans API

Manage security scans for your repositories and retrieve scan results.

POST/v1/projects/{project_id}/scans

Start a new security scan for a project

Request:

{ "scan_types": ["sast", "secrets", "dependencies"], "branch": "main", "notify_on_completion": true }

Response:

{ "scan_id": "scan_123abc", "status": "pending", "project_id": "proj_456def", "created_at": "2024-01-15T10:30:00Z", "estimated_completion": "2024-01-15T10:32:00Z" }

GET/v1/scans/{}scan_id{}

Get scan status and results

Response:

{ "scan_id": "scan_123abc", "status": "completed", "findings_count": 12, "critical": 2, "high": 4, "medium": 5, "low": 1, "scan_duration": 45.2, "findings_url": "/v1/scans/scan_123abc/findings" }

GET/v1/scans/{}scan_id{}/findings

List all findings from a scan with filtering options

Findings API

Retrieve, filter, and manage security findings across your projects.

GET/v1/findings

List findings with filtering and pagination

Query Parameters: severity, status, project_id, scan_type, limit, offset

Example Request:

GET /v1/findings?severity=critical,high&status=open&limit=20

PATCH/v1/findings/{}finding_id{}

Update finding status, assignee, or add notes

Request:

{ "status": "resolved", "assignee": "user_789xyz", "resolution_notes": "Fixed in commit abc123" }

POST/v1/findings/{}finding_id{}/patch

Generate AutoPatch for a specific finding

Projects API

Manage projects, repositories, and security configurations.

GET/v1/projects

List all projects

POST/v1/projects

Create new project

GET/v1/projects/{}id{}

Get project details

PATCH/v1/projects/{}id{}

Update project settings

SDKs & Libraries

Official SDKs and community libraries for popular programming languages

Node.js / JavaScript

Official SDK for Node.js applications with TypeScript support and comprehensive examples.

# Install

npm install @vibeguard/sdk

# Usage

const vg = new VibeGuard(apiKey); await vg.scans.create(projectId);

GitHub Repository →Documentation →

Python

Pythonic SDK with async support, perfect for automation scripts and data analysis workflows.

# Install

pip install vibeguard

# Usage

from vibeguard import Client client = Client(api_key="...") scan = client.scans.create(project_id)

GitHub Repository →Documentation →

Go

Lightweight Go SDK optimized for microservices and CLI tools with excellent performance.

# Install

go get github.com/vibeguard/go-sdk

# Usage

client := vibeguard.New(apiKey) scan, _ := client.Scans.Create(ctx, projectID)

GitHub Repository →Documentation →

Don't see your language? We also support Java, C#, Ruby, and PHP.

View All SDKs

Webhooks

Real-time notifications for scan completion, new findings, and security events

Webhook Events

Subscribe to these events to get real-time updates about security scans and findings.

scan.completed

Triggered when a security scan finishes

finding.critical

New critical severity finding discovered

patch.generated

AutoPatch successfully generated for finding

compliance.updated

Compliance status changed for project

Webhook Configuration

Configure webhook endpoints through the API or dashboard settings.

# Create webhook endpoint

POST /v1/webhooks { "url": "https://yourapp.com/webhooks", "events": ["scan.completed", "finding.critical"], "secret": "your_webhook_secret" }

# Webhook payload example

{ "event": "scan.completed", "scan_id": "scan_123abc", "project_id": "proj_456def", "status": "completed", "findings_count": 12, "timestamp": "2024-01-15T10:32:00Z" }

Rate Limits & Best Practices

Guidelines for efficient and reliable API usage

Rate Limits

Standard Plan1,000 requests/hour

Professional Plan5,000 requests/hour

Enterprise Plan25,000 requests/hour

Scan EndpointsSpecial limits apply

⚡

Rate Limit Headers

Check X-RateLimit-Remaining and X-RateLimit-Reset headers to monitor usage

Best Practices

Use pagination

Limit large result sets with offset/limit parameters

Implement retries

Use exponential backoff for rate-limited requests

Cache responses

Cache static data like project configurations

Use webhooks

Prefer webhooks over polling for real-time updates

API Support

Get help with API integration and development

🛠️ Technical Support

Get help with API integration, debugging, and technical questions from our engineering team.

Contact Technical Support →

💬 Developer Community

Join our developer community to share code, ask questions, and learn from other developers.

Join Community →

📖 Interactive Docs

Try our interactive API explorer to test endpoints and see live responses.

API Playground →

🎯 Enterprise Support

Enterprise customers get dedicated API support with custom integrations and SLA guarantees.

Enterprise Support →

Ready to start building?

Get your API key and start integrating VibeGuard security into your applications today

Get API Key Quick Start Guide

Free tier includes 1,000 API requests/hour • No credit card required • Full documentation