GitHub Code-Scanning API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Code Scanning. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.
This API exposes
13 operations
across 10 paths,
and defines 50 schemas.
It is described by OpenAPI 3.2.0, at version 1.1.4.
Requests are made against a single base URL, {protocol}://{hostname}/api/v3.
The identity and technical contract details declared by the specification.
code-scanning-ref
string
The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .
code-scanning-alert-instance
object
10 properties
code-scanning-analysis-tool-guid
stringnull
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
code-scanning-analysis-tool-name
string
The name of the tool used to generate the code scanning analysis.
alert-instances-url
string
The REST API URL for fetching the list of instances for an alert.
code-scanning-default-setup-update-response
object
You can use runurl to track the status of the run. This includes a property status and conclusion. You should not rely on this always being an actions workflow…
2 properties
alert-dismissed-at
stringnull
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-sarif-id
string
An identifier for the upload.
code-scanning-analysis
object
15 properties
14 required
code-scanning-alert-location
object
Describe a region within a file for the alert.
5 properties
code-scanning-sarifs-status
object
3 properties
code-scanning-alert-classification
stringnull
A classification of the file. For example to identify it as generated.
nullable-simple-user
objectnull
A GitHub user.
21 properties
18 required
code-scanning-alert-environment
string
Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language tha…
code-scanning-analysis-analysis-key
string
Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-alert-items
object
15 properties
12 required
code-scanning-analysis-environment
string
Identifies the variable values associated with the environment in which this analysis was performed.
code-scanning-default-setup-update
object
Configuration for code scanning default setup.
2 properties
1 required
code-scanning-sarifs-receipt
object
2 properties
scim-error
object
Scim Error
6 properties
code-scanning-alert-state-query
string
State of a code scanning alert.
simple-repository
object
A GitHub repository.
46 properties
46 required
code-scanning-analysis-created-at
string
The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-organization-alert-items
object
16 properties
13 required
code-scanning-analysis-tool-version
stringnull
The version of the tool used to generate the code scanning analysis.
empty-object
object
An object without any properties.
code-scanning-analysis-tool
object
3 properties
code-scanning-alert-dismissed-comment
stringnull
The dismissal comment associated with the dismissal of the alert.
alert-url
string
The REST API URL of the alert resource.
code-scanning-analysis-sarif-file
string
A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [gzip](http://www.gnu.org/software/gzip/manual/gzip.html)…
code-scanning-alert-state
string
State of a code scanning alert.
code-scanning-default-setup
object
Configuration for code scanning default setup.
4 properties
code-scanning-alert-severity
string
Severity of a code scanning alert.
alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-url
string
The REST API URL of the analysis resource.
code-scanning-alert-dismissed-reason
stringnull
Required when the state is dismissed. The reason for dismissing or closing the alert.
alert-html-url
string
The GitHub URL of the alert resource.
code-scanning-alert
object
15 properties
12 required
code-scanning-alert-rule
object
9 properties
code-scanning-alert-rule-summary
object
6 properties
simple-user
object
A GitHub user.
21 properties
18 required
code-scanning-analysis-commit-sha
string
The SHA of the commit to which the analysis you are uploading relates.
code-scanning-analysis-category
string
Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed o…
basic-error
object
Basic Error
4 properties
code-scanning-alert-set-state
string
Sets the state of the code scanning alert. You must provide dismissedreason when you set the state to dismissed.
alert-number
integer
The security alert number.
code-scanning-ref-full
string
The full Git reference, formatted as refs/heads/ , refs/tags/ , refs/pull/ /merge, or refs/pull/ /head.
alert-fixed-at
stringnull
The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-deletion
object
Successful deletion of a code scanning analysis
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GitHub publishes across the network.
