Scanners
Note
These APIs are subject to change at any time and are for internal use only.
Post - Push results
This endpoint allows a scanner to push results for an existing version.
Note
Requires JWT authentication using the service account credentials associated with the scanner webhook.
- POST /api/v5/scanner/results/
- Request JSON Object:
version_id (integer) – The primary key of the add-on version.
results (object) – The scanner results.
- Status Codes:
201 Created – Result created successfully.
400 Bad Request – Invalid payload.
403 Forbidden – Authentication failed or the authenticated user is not the service account of an active webhook with a push event.
Patch - Update results
This endpoint allows to update scanner results.
Note
Requires JWT authentication using the service account credentials associated with the scanner webhook.
- PATCH /api/v5/scanner/results/(int: pk)/
- Query Parameters:
id (string) – The scanner result ID.
- Request JSON Object:
results (object) – The scanner results.
- Status Codes:
204 No Content – Results successfully updated.
400 Bad Request – Invalid payload.
409 Conflict – Scanner results already recorded.