Skip to main content
GET
Download a completed lockfile analysis

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-GitHits-Client-Name
string

Optional client attribution: trimmed printable ASCII, at most 80 bytes. Invalid optional values are dropped.

X-GitHits-Client-Version
string

Optional client-version attribution: trimmed printable ASCII, at most 80 bytes. Invalid optional values are dropped.

X-GitHits-Agent
string

Optional agent attribution: trimmed printable ASCII, at most 160 bytes. Invalid optional values are dropped.

X-GitHits-Session-ID
string

Optional caller-defined session ID: one to 64 ASCII letters, digits, underscores or hyphens, preserved exactly. Supply the header at most once. Invalid supplied IDs return 400 INVALID_SESSION_ID; no session is created.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]{1,64}$

Path Parameters

id
string<uuid>
required

Hyphenated UUID returned when the job was accepted.

Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

Response

The completed UTF-8 analysis document in the format selected at submission. SBOM passes synchronous format validation; audit and dependency-diff JSON pass version-aware envelope validation. Diff reports preserve source-local changes, accepted-file digests, independent advisory/review coverage and entry-scoped changelog links unchanged. Response vocabularies and additive fields remain open; unfamiliar values must never be read as pass/safe evidence. The immutable document is at most 16,777,216 bytes and must not be cached.

Audit response dispatched by returned schema_version: retained v1, default v2, opt-in native lifecycle v3, and opaque future versions. Requested version is not a guarantee of returned version.

coverage
object
required

Independent advisory, metadata, duplicate and source completeness evidence.

findings
object
required

Confirmed vulnerability, deprecation, outdated and duplicate findings with occurrence attribution.

generated_at
string<date-time>
required

UTC time when report assembly occurred.

inputs
object
required

Manifest, declaration, subject, association and parsing evidence from the uploaded files.

notices
string[]
required

Producer notices about source scope, freshness and remedy applicability. Text and count may evolve.

occurrences
object[]
required

Original dependency records and manifest-derived resolutions, including excluded sources.

report_id
string<uuid>
required

The stable source inventory UUID; the job ID remains the retrieval pointer.

schema_version
enum<integer>
required

Version 1 uses the documented audit structure.

Available options:
1
summary
object
required

Counts for this combined upload; findings, evidence gaps and source coverage use separate denominators.

unknowns
object
required

Incomplete checks, source gaps and excluded occurrences retained alongside findings.