API Overview¶
RHACS CVE Manager exposes a REST API under /api.
Base URLs¶
| Environment | URL |
|---|---|
| Local | http://localhost:8000/api |
| Hub | https://<hub-api-route>/api |
| Spoke | proxied through spoke nginx to hub |
Authentication Order¶
DEV_MODE=true(dev-only bypass)- Spoke mode via
X-Api-Key - OIDC bearer token
Authorization¶
team_member: namespace-scoped CVE visibility, risk acceptance requests, badge managementsec_team: full administrative access (priorities, settings, audit, reviews)- wildcard all-namespace users: still
team_member, but withX-Forwarded-Namespaces: */has_all_namespaces=trueso they can query all namespaces without gaining sec-team-only permissions
Response Patterns¶
- JSON payloads for all API routes
- Paginated responses:
- Validation errors return FastAPI
detailobjects/arrays
Health and OpenAPI¶
GET /health(no auth)- Swagger UI:
/docs - ReDoc:
/redoc - OpenAPI JSON:
/openapi.json
See Endpoints for full contract details.