v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB
code-scanning

Get information about a SARIF upload

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "Get a code scanning analysis for a repository." You must use an access token with the security_events scope to use this endpoint with private repos, the public_repo scope also grants permission to read security events on public repos only.

get/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

sarif_idstring required

The SARIF ID obtained after uploading.

Response

Response

processing_status'pending' | 'complete' | 'failed'

pending files have not yet been processed, while complete means results from the SARIF have been stored. failed files have either not been processed at all, or could only be partially processed.

analyses_urlstring uri nullable

The REST API URL for getting the analyses associated with the upload.

errorsstring[] nullable

Any errors that ocurred during processing of the delivery.