GET/repos/{owner}/{repo}/secret-scanning/scan-history

Get secret scanning scan history for a repository

Lists the latest default incremental and backfill scans by type for a repository.

[!NOTE] This endpoint requires GitHub Advanced Security.

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

3 status codes

200Response

incremental_scansarray<object>optional

pattern_update_scansarray<object>optional

backfill_scansarray<object>optional

custom_pattern_backfill_scansarray<object>optional

generic_secrets_backfill_scansarray<object>optional

404Repository does not have GitHub Advanced Security or secret scanning enabled

503Service unavailable

codestringoptional

messagestringoptional

documentation_urlstringoptional

Error handling

A 404 is returned: Repository does not have GitHub Advanced Security or secret scanning enabled. A 503 is returned: Service unavailable.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.scanHistory.list({
  owner: "octocat",
  repo: "hello-world",
});

{
  "incremental_scans": [
    {
      "type": "git",
      "status": "completed",
      "completed_at": "2024-10-07T02:47:00Z"
    }
  ],
  "backfill_scans": [
    {
      "type": "git",
      "status": "completed",
      "started_at": "2024-10-07T02:47:00Z",
      "completed_at": "2024-10-07T02:50:00Z"
    },
    {
      "type": "issue",
      "status": "completed",
      "started_at": "2024-10-07T02:47:00Z",
      "completed_at": "2024-10-07T02:49:00Z"
    },
    {
      "type": "discussion",
      "status": "completed",
      "started_at": "2024-10-07T02:47:00Z",
      "completed_at": "2024-10-07T02:48:00Z"
    }
  ],
  "pattern_update_scans": [
    {
      "type": "discussion",
      "status": "in_progress",
      "started_at": "2024-10-07T02:47:00Z",
      "completed_at": "2024-10-07T02:51:00Z"
    }
  ],
  "custom_pattern_backfill_scans": [
    {
      "type": "git",
      "status": "completed",
      "started_at": "2024-10-07T02:47:00Z",
      "completed_at": "2024-10-07T02:55:00Z",
      "pattern_slug": "my-custom-pattern",
      "pattern_scope": "enterprise"
    },
    {
      "type": "git",
      "status": "completed",
      "started_at": "2024-10-07T02:47:00Z",
      "completed_at": "2024-10-07T02:55:00Z",
      "pattern_slug": "my-custom-pattern",
      "pattern_scope": "organization"
    }
  ],
  "generic_secrets_backfill_scans": [
    {
      "type": "git",
      "status": "completed",
      "started_at": "2024-10-07T02:47:00Z",
      "completed_at": "2024-10-07T02:55:00Z"
    }
  ]
}

Was this helpful?

Request

Response

Errors