Sample - GitHub REST API
GET/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}

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." OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
sarif_idstringrequired
The SARIF ID obtained after uploading.

4 status codes
200Response
processing_statusstringoptional
`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.
Allowed:pendingcompletefailed
analyses_urlstringoptional
The REST API URL for getting the analyses associated with the upload.
errorsarray<string>optional
Any errors that ocurred during processing of the delivery.
403Response if GitHub Advanced Security is not enabled for this repository
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Not Found if the sarif id does not match any upload
503Service unavailable
codestringoptional
messagestringoptional
documentation_urlstringoptional

Error handling

A 403 is returned: Response if GitHub Advanced Security is not enabled for this repository. A 404 is returned: Not Found if the sarif id does not match any upload. A 503 is returned: Service unavailable.