Skip to main content
GET
Scan a repository
Scans the default branch of a public repository and returns one report covering:
  • Dependencies in npm (package.json with package-lock.json, npm-shrinkwrap.json, pnpm-lock.yaml or yarn.lock) and Python (requirements*.txt, pyproject.toml, poetry.lock, uv.lock): known malware, known vulnerabilities, outdated, deprecated and yanked versions, possible typosquats, packages installed from URLs, and missing lockfiles.
  • Unused npm dependencies: runtime dependencies that no file in the package imports.
  • Workflows in .github/workflows, with the same rules as Analyze a workflow.
  • CI files such as package scripts, setup.py, conftest.py, Makefiles and shell scripts, with the same rules as Analyze CI files.
It is meant as a fast first look, not a full audit. Repository files are analyzed in memory and not stored. This endpoint has its own rate limit of 2 scans per hour and 10 per day.

Path parameters

Example

Response

Finding

Checks

Each check has a status of complete, partial or skipped, and a reason when it is not complete. A check is partial when some items could not be checked, for example when an upstream service was slow or the repository is very large, and skipped when there was nothing to check. Vulnerabilities are only checked for versions that are actually known: versions in a lockfile, or exact versions in a manifest. Dependencies declared as ranges without a lockfile are reported in checks.vulnerabilities.reason, because the version that gets installed depends on when you install.

Dependency rules

Workflow findings use the workflow rules and CI file findings use the CI file rules.

Caching

Results are cached for 10 minutes per repository (Cache-Control: public, max-age=600). Requesting a cached result does not count against your limit.

Errors

Limits

Only public repositories and the default branch are scanned. Unused dependency detection reads static imports, so packages loaded by a framework, plugin system or dynamic require can show up as unused. Check before removing them.

Path Parameters

owner
string
required
Pattern: ^[A-Za-z0-9_.-]{1,100}$
repo
string
required
Pattern: ^[A-Za-z0-9_.-]{1,100}$

Response

Repository scan report

repository
object
required
summary
object
required
findings
object[]
required
dependencies
object
required
workflows
object[]
required
checks
object
required
checked_at
string<date-time>
required