DOCS_V2.0.4

Documentation

Getting Started

The DNA Check

Living Shield SDK

The Hive Mind

API Reference

Integrate Securely into your CI/CD pipeline, custom tooling, or security dashboard with our REST API. All endpoints require a valid API key via the Authorization: Bearer <key> header.

Scanning

POST/api/v1/scan/initInitialize a new security scan (repo URL, source code, or live URL)
GET/api/v1/scan/:idRetrieve scan results by scan ID
GET/api/v1/scan/:id/streamStream real-time scan progress via Server-Sent Events
POST/api/v1/scan/uploadUpload a ZIP archive for scanning
POST/api/v1/scan/:id/approveApprove and apply an auto-fix patch

Scanner Modules

Individual scanner endpoints — all POST requests accepting source code in the request body.

/scanners/env— Environment & secrets scanning
/scanners/iac— Infrastructure-as-Code (Terraform, K8s)
/scanners/docker— Dockerfile & container security
/scanners/cicd— CI/CD pipeline hardening
/scanners/licenses— License compliance checks
/scanners/rate-limits— Rate limiting audit
/scanners/sbom— SBOM generation (CycloneDX/SPDX)
/scanners/api-contract— API contract validation
/scanners/classify— Vulnerability classification

Hive Mind

GET/hivemind/feed
GET/hivemind/stats
POST/hivemind/report

Living Shield

POST/shield/classify
POST/shield/patch
POST/shield/logs
GET/shield/models

User & Account

GET/api/v1/user/profileGet user profile, tier, and usage stats
GET/api/v1/user/scansList user's scan history with results
POST/api/v1/checkoutCreate a Stripe checkout session for tier upgrade

Quick Example

# Initiate a repository scan
curl -X POST https://securely-api.onrender.com/api/v1/scan/init \
-H "Authorization: Bearer $SECURELY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target": "github.com/org/repo",
"scan_type": "repo",
"tier": "shield"
}'

# Stream scan results in real-time
curl -N https://securely-api.onrender.com/api/v1/scan/SCAN_ID/stream \
-H "Authorization: Bearer $SECURELY_API_KEY"

The Vibe-Coder's Fast-Track

Learn how to secure your AI-generated codebase in under 5 minutes. No security background required.

Join the Community

Report bugs, suggest features, discuss security patterns, and help shape the future of Securely. Our Discord is where the team and community connect.

Join Discord