APIs.io Engineering Platform Code-Scanning API
Retrieve code scanning alerts from a repository.
This API exposes 13 operations across 10 paths, and defines 50 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
13 operations
10 paths
50 schemas
1 DELETE9 GET2 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Code-Scanning API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 13
Across 10 paths, the API surfaces 13 operations — 1 DELETE, 9 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Code-Scanning 13
Retrieve code scanning alerts from a repository.
GET
/enterprises/{enterprise}/code-scanning/alerts
APIs.io Engineering Platform List code scanning alerts for an enterprise
GET
/orgs/{org}/code-scanning/alerts
APIs.io Engineering Platform List code scanning alerts for an organization
GET
/repos/{owner}/{repo}/code-scanning/alerts
APIs.io Engineering Platform List code scanning alerts for a repository
GET
/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
APIs.io Engineering Platform Get a code scanning alert
PATCH
/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
APIs.io Engineering Platform Update a code scanning alert
GET
/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances
APIs.io Engineering Platform List instances of a code scanning alert
GET
/repos/{owner}/{repo}/code-scanning/analyses
APIs.io Engineering Platform List code scanning analyses for a repository
GET
/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}
APIs.io Engineering Platform Get a code scanning analysis for a repository
DELETE
/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}
APIs.io Engineering Platform Delete a code scanning analysis from a repository
GET
/repos/{owner}/{repo}/code-scanning/default-setup
APIs.io Engineering Platform Get a code scanning default setup configuration
PATCH
/repos/{owner}/{repo}/code-scanning/default-setup
APIs.io Engineering Platform Update a code scanning default setup configuration
POST
/repos/{owner}/{repo}/code-scanning/sarifs
APIs.io Engineering Platform Upload an analysis as SARIF data
GET
/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}
APIs.io Engineering Platform Get information about a SARIF upload
Schemas 50
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are simple-repository (46 properties), nullable-simple-user (21 properties), simple-user (21 properties), code-scanning-organization-alert-items (16 properties). Each schema is shown below with its type and property counts.
nullable-simple-user
object
A GitHub user.
21 properties
18 required
alert-html-url
string
The GitHub URL of the alert resource.
code-scanning-analysis-tool-version
string
The version of the tool used to generate the code scanning analysis.
code-scanning-default-setup-update
object
Configuration for code scanning default setup.
2 properties
1 required
code-scanning-default-setup
object
Configuration for code scanning default setup.
4 properties
alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-fixed-at
string
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-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-analysis-created-at
string
The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
simple-repository
object
A GitHub repository.
46 properties
46 required
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…
code-scanning-analysis-tool
object
3 properties
code-scanning-sarifs-status
object
3 properties
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
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.
code-scanning-alert-rule
object
9 properties
basic-error
object
Basic Error
4 properties
code-scanning-analysis
object
15 properties
14 required
scim-error
object
Scim Error
6 properties
code-scanning-organization-alert-items
object
16 properties
13 required
code-scanning-analysis-tool-guid
string
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
code-scanning-alert-rule-summary
object
6 properties
code-scanning-alert-instance
object
10 properties
code-scanning-alert-classification
string
A classification of the file. For example to identify it as generated.
code-scanning-alert-severity
string
Severity of a code scanning alert.
alert-dismissed-at
string
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-sarifs-receipt
object
2 properties
code-scanning-analysis-tool-name
string
The name of the tool used to generate the code scanning analysis.
code-scanning-ref-full
string
The full Git reference, formatted as refs/heads/ , refs/tags/ , refs/pull/ /merge, or refs/pull/ /head.
alert-number
integer
The security alert number.
alert-instances-url
string
The REST API URL for fetching the list of instances for an alert.
code-scanning-alert-state
string
State of a code scanning alert.
code-scanning-alert
object
15 properties
12 required
code-scanning-alert-dismissed-reason
string
Required when the state is dismissed. The reason for dismissing or closing the alert.
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-alert-state-query
string
State of a code scanning alert.
code-scanning-alert-items
object
15 properties
12 required
code-scanning-analysis-deletion
object
Successful deletion of a code scanning analysis
2 properties
2 required
simple-user
object
A GitHub user.
21 properties
18 required
code-scanning-alert-location
object
Describe a region within a file for the alert.
5 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.
empty-object
object
An object without any properties.
code-scanning-analysis-commit-sha
string
The SHA of the commit to which the analysis you are uploading relates.
code-scanning-alert-dismissed-comment
string
The dismissal comment associated with the dismissal of the alert.
code-scanning-analysis-url
string
The REST API URL of the analysis resource.
code-scanning-ref
string
The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .
alert-url
string
The REST API URL of the alert resource.
code-scanning-analysis-environment
string
Identifies the variable values associated with the environment in which this analysis was performed.
code-scanning-analysis-sarif-id
string
An identifier for the upload.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Code-Scanning