Get information about a SARIF upload

GET

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

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. GitHub Apps must have the security_events read permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///code-scanning/sarifs/'

Response Example

200 - Example 1

{
    "analyses_url": "http://example.com",
    "errors": [
        "string"
    ],
    "processing_status": "pending"
}

Request

Path Params

owner

string

required

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

repo

string

required

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

sarif_id

string

required

The SARIF ID obtained after uploading.

Responses

🟢200Response

application/json

Body

analyses_url

string <uri> | null

read-onlyoptional

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

errors

array[string] | null

read-onlyoptional

Any errors that ocurred during processing of the delivery.

processing_status

enum<string>

optional

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 values:

pendingcompletefailed

🟠403403

🟠404Not Found if the sarif id does not match any upload

🔴503503

Modified at 2023-08-15 02:59:30

Upload an analysis as SARIF data

Create a blob