Security

Export findings as SARIF

Returns the findings of a project as a SARIF 2.1.0 document, which GitHub code scanning and comparable tools ingest directly. Upload it from your pipeline and the findings show up next to the code they concern. Without a status filter it returns the open ones, which is what a build gate wants.

get/api/projects/{projectId}/security/findings/export/sarif

Request

  • Base URL: https://api.routebase.dev
  • URL: https://api.routebase.dev/api/projects/{projectId}/security/findings/export/sarif
  • Auth: API key in header X-API-Key

Path parameters

ProjectIdstring uuid required

Public id of the project.

Query parameters

status'open' | 'inProgress' | 'fixed' | 'falsePositive' | 'acceptedRisk' | 'duplicate'

Where a finding stands in triage.

Filter by finding status. Defaults to open.

Headers

X-RB-Regionstring
Example:us

Region of your organization. US organizations must send us; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.

Response

The SARIF document.

Changes

No recorded changes to this operation across all 1 revision of this API.