OpenAPI reference
The rendered API reference is backed by the same contract exposed as JSON.
The OpenAPI document is the source of truth for public docs, authenticated portal docs, smoke checks, and future SDK generation. Use /api/openapi.json for the full contract or /api/v1/openapi.json for the versioned alias.
Operations
- POST /api/v1/scans/upload-intents
- Create a scan upload intent
- POST /api/v1/scans/url-intents
- Create a URL scan
- POST /api/v1/scans/{scanId}/upload-complete
- Complete a scan upload
- GET /api/v1/scans
- List scans
- GET /api/v1/scans/{scanId}
- Get a scan
- GET /api/v1/scans/{scanId}/job
- Get a scan job
- POST /api/v1/cases
- Create a case
- GET /api/v1/cases
- List cases
- GET /api/v1/cases/{caseId}
- Get a case
- POST /api/v1/monitoring/sources
- Create a monitoring source
- GET /api/v1/monitoring/sources
- List monitoring sources
- POST /api/v1/monitoring/events
- Create a monitoring event
- GET /api/v1/monitoring/events
- List monitoring events
- POST /api/v1/webhooks
- Create a webhook endpoint
- GET /api/v1/webhooks
- List webhook endpoints
- POST /api/v1/webhooks/{webhookId}/status
- Update a webhook's status
- POST /api/v1/webhooks/{webhookId}/test
- Send a signed test event
- GET /api/v1/webhooks/deliveries
- List webhook deliveries
Contract URLs
The JSON document is cacheable and safe to expose because it contains schemas and examples, not API keys.