v1.0.0 Stable•6 min read
REST API v1 Overview
Programmatic REST API for managing projects, triggering security scans, querying findings, and orchestrating automated pull requests.
1. Base URL & Endpoints
All API requests must be issued over HTTPS. In local development, the API server runs on port 8000 by default.
2. Standard Response Format
Responses are returned as standard JSON. Timestamps follow ISO 8601 UTC format. IDs are 128-bit RFC 4122 UUID v4 strings.
3. HTTP Status Codes
- 200 OK: Request succeeded.
- 201 Created: Resource created.
- 400 Bad Request: Invalid payload or validation error.
- 401 Unauthorized: Missing or invalid Bearer token.
- 403 Forbidden: Insufficient role permissions.
- 404 Not Found: Target resource does not exist.
- 429 Too Many Requests: Rate limit exceeded.
- 500 Internal Error: Server execution failure.
