Scanners

Note

These APIs are subject to change at any time and are for internal use only.

List scanner results

This endpoint returns a list of labelled scanner results.

Note

Requires authentication and the current user to have read access to the scanner results.

GET /api/v5/scanner/results/
Query Parameters:

  • label (string) – Filter by label.

  • scanner (string) – Filter by scanner name.

Response JSON Object:

  • id (int) – The scanner result ID.

  • scanner (string) – The scanner name.

  • label (string) – Either good or bad.

  • results (object) – The scanner (raw) results.

  • created (string) – The date the result was created, formatted with this format.

  • model_version (string|null) – The model version when applicable, null otherwise.

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: