Code Scanning

Retrieve code scanning alerts from a repository.

Operations

MethodEndpointDescription
GET/orgs/{org}/code-scanning/alertsList code scanning alerts for an organization
GET/repos/{owner}/{repo}/code-scanning/alertsList code scanning alerts for a repository
GET/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}Get a code scanning alert
PATCH/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}Update a code scanning alert
GET/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofixGet the status of an autofix for a code scanning alert
POST/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofixCreate an autofix for a code scanning alert
POST/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commitsCommit an autofix for a code scanning alert
GET/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instancesList instances of a code scanning alert
GET/repos/{owner}/{repo}/code-scanning/analysesList code scanning analyses for a repository
GET/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}Get a code scanning analysis for a repository
DELETE/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}Delete a code scanning analysis from a repository
GET/repos/{owner}/{repo}/code-scanning/codeql/databasesList CodeQL databases for a repository
GET/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}Get a CodeQL database for a repository
DELETE/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}Delete a CodeQL database
POST/repos/{owner}/{repo}/code-scanning/codeql/variant-analysesCreate a CodeQL variant analysis
GET/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}Get the summary of a CodeQL variant analysis
GET/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}Get the analysis status of a repository in a CodeQL variant analysis
GET/repos/{owner}/{repo}/code-scanning/default-setupGet a code scanning default setup configuration
PATCH/repos/{owner}/{repo}/code-scanning/default-setupUpdate a code scanning default setup configuration
POST/repos/{owner}/{repo}/code-scanning/sarifsUpload an analysis as SARIF data
GET/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}Get information about a SARIF upload

Example

List code scanning alerts for an organization, with the TypeScript SDK:

ts
import { GitHubV3REST } from "github";

const client = new GitHubV3REST({
  baseUrl: "https://api.github.com",
});

const result = await client.codeScanning.listAlertsForOrg({
  org: "org",
});
console.log(result);
Nine more languages

The same call exists in every SDK. See SDKs for the other nine.