REFERENCE

API DOCUMENTATION

Programmatic access to ScanMyVibe security scanning. Requires an Enterprise plan.

AUTHENTICATION

All API requests require a Bearer token. Generate API keys in your dashboard.

Authorization: Bearer smv_your_api_key_here

BASE URL

https://scanmyvibe.co

ENDPOINTS

POST/api/v1/scan

Start a new security scan

AUTHORIZATION

Bearer <api-key>

REQUEST BODY

{ "url": "https://example.com" }

RESPONSE (201 Created)

{ "scanId": "uuid", "status": "pending", "pollUrl": "/api/v1/scan/{id}" }

GET/api/v1/scan/:id

Get scan results (poll until status = "completed")

AUTHORIZATION

Bearer <api-key>

RESPONSE (200 OK)

{ "scanId": "uuid", "url": "...", "score": 85, "status": "completed", "vulnerabilities": [...], "summary": { "critical": 0, ... } }

QUICK START

CURL EXAMPLE

# 1. Start a scan
curl -X POST https://scanmyvibe.co/api/v1/scan \
  -H "Authorization: Bearer smv_your_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

# 2. Poll for results (repeat until status = "completed")
curl https://scanmyvibe.co/api/v1/scan/{scanId} \
  -H "Authorization: Bearer smv_your_key"

RATE LIMITS

→ Enterprise: 1000 API calls/day

→ Scan results are available for 24 hours after completion

→ Each vulnerability includes OWASP Top 10 category and CVSS 3.1 score