Bearer-token creation, scopes, pagination, filtering, and error shape.
API authentication and reads
Create a token
./.venv/bin/python manage.py create_api_token \
--user USERNAME_OR_EMAIL --name ci-runner --scopes read,write,ingest
The raw bearer token is printed once. SimTrack stores only its SHA-256 hash. Send the token in Authorization: Bearer <token>.
Scope boundaries
| Scope | Allows |
|---|---|
| read | Retrieve projects, regressions, runs, results, failure signatures, and schema. |
| write | Create and patch projects, regressions, and runs. |
| ingest | Submit a complete regression-run payload from CI or another tool. |
Read endpoints
GET /api/v1/projects/
GET /api/v1/regressions/
GET /api/v1/runs/
GET /api/v1/results/
GET /api/v1/failure-signatures/
GET /api/v1/schema/
List endpoints use limit/offset pagination and accept relevant filters including project, regression, run, status, branch, suite, created_after, and created_before.
Stable error envelope
{"error":"validation_error","message":"Request validation failed.","fields":{"name":["This field is required."]}}