Secret Scanning

Retrieve secret scanning alerts from a repository.

Operations

Method	Endpoint	Description
`GET`	`/orgs/{org}/secret-scanning/alerts`	List secret scanning alerts for an organization
`GET`	`/orgs/{org}/secret-scanning/custom-patterns`	List organization custom patterns
`POST`	`/orgs/{org}/secret-scanning/custom-patterns`	Bulk create organization custom patterns
`DELETE`	`/orgs/{org}/secret-scanning/custom-patterns`	Bulk delete organization custom patterns
`PATCH`	`/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}`	Update an organization custom pattern
`GET`	`/orgs/{org}/secret-scanning/pattern-configurations`	List organization pattern configurations
`PATCH`	`/orgs/{org}/secret-scanning/pattern-configurations`	Update organization pattern configurations
`GET`	`/repos/{owner}/{repo}/secret-scanning/alerts`	List secret scanning alerts for a repository
`GET`	`/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`	Get a secret scanning alert
`PATCH`	`/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`	Update a secret scanning alert
`GET`	`/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations`	List locations for a secret scanning alert
`GET`	`/repos/{owner}/{repo}/secret-scanning/custom-patterns`	List repository custom patterns
`POST`	`/repos/{owner}/{repo}/secret-scanning/custom-patterns`	Bulk create repository custom patterns
`DELETE`	`/repos/{owner}/{repo}/secret-scanning/custom-patterns`	Bulk delete repository custom patterns
`PATCH`	`/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}`	Update a repository custom pattern
`POST`	`/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses`	Create a push protection bypass
`GET`	`/repos/{owner}/{repo}/secret-scanning/scan-history`	Get secret scanning scan history for a repository

Example

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

import { GitHubV3REST } from "github";

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

const result = await client.secretScanning.listAlertsForOrg({
  org: "org",
});
console.log(result);

Nine more languages

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