GitHub: Get secret scanning scan history for a repository

← Secret scanning operations · Get started

Operation github.secret_scanning_get_scan_history

Provider route: GET /repos/{owner}/{repo}/secret-scanning/scan-history. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["secretScanning"]["secretScanningGetScanHistory"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.secretScanning.secretScanningGetScanHistory(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.secret_scanning.secret_scanning_get_scan_history(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get secret scanning scan history for a repository — response body

Referenced models: Get secret scanning scan history for a repository — response body

Schemas

Get secret scanning scan history for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root
backfill_scans	array	Optional
backfill_scans[]	Model	Each item	Expand Get secret scanning scan history for a repository — response body — backfill scans item
custom_pattern_backfill_scans	array	Optional
custom_pattern_backfill_scans[]	JSON	Each item
custom_pattern_backfill_scans[] (allOf 1)	Model	All variants apply	Expand Get secret scanning scan history for a repository — response body — backfill scans item
custom_pattern_backfill_scans[] (allOf 2)	object	All variants apply
custom_pattern_backfill_scans[] (allOf 2).pattern_name	string	Optional	Name of the custom pattern for custom pattern scans
custom_pattern_backfill_scans[] (allOf 2).pattern_scope	string	Optional	Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise"
generic_secrets_backfill_scans	array	Optional
generic_secrets_backfill_scans[]	Model	Each item	Expand Get secret scanning scan history for a repository — response body — backfill scans item
incremental_scans	array	Optional
incremental_scans[]	Model	Each item	Expand Get secret scanning scan history for a repository — response body — backfill scans item
pattern_update_scans	array	Optional
pattern_update_scans[]	Model	Each item	Expand Get secret scanning scan history for a repository — response body — backfill scans item

Referenced models: Get secret scanning scan history for a repository — response body — backfill scans item

Get secret scanning scan history for a repository — response body — backfill scans item

Field	Type	Presence	Description and constraints
$	object	Root	Information on a single scan performed by secret scanning on the repository
completed_at	JSON	Optional
completed_at (anyOf 1)	string	Alternative	The time that the scan was completed. Empty if the scan is running Format: date-time
completed_at (anyOf 2)	null	Alternative
started_at	JSON	Optional
started_at (anyOf 1)	string	Alternative	The time that the scan was started. Empty if the scan is pending Format: date-time
started_at (anyOf 2)	null	Alternative
status	string	Optional	The state of the scan. Either "completed", "running", "pending", "failed", or "unknown". "failed": this scan type has hit its retry limit and has been marked permanently failed. This usually resolves on its own at the next scheduled scan attempt. If "failed" persists, contact Support. "unknown": the scan is in an unrecognized or currently unhandled state.
type	string	Optional	The type of scan

Policy, approvals and errors

SDK function policy ID: github.secret_scanning_get_scan_history. Catalog operation: secret-scanning/get-scan-history. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source