Download a completed lockfile analysis
Download the completed document in the format selected at submission. Only state=succeeded indicates that the result is ready. The response format is determined by the upstream’s allowlisted media type; Accept does not select it. SBOM uses the same format-specific validation as synchronous /v1/experimental/sbom. Audit JSON receives complete syntax and version-aware envelope validation, preserving original evidence bytes. Version 2 contains compact findings, source paths, duplicate requirement origins and explicit coverage gaps. Opt-in version 3 replaces legacy deprecated lists and coverage with canonical native lifecycle findings, attributed observations and exact paths, retained legacy warnings, independent coverage and unknowns. summary.lifecycle and summary.retained_lifecycle_warnings are not vulnerability counts. Unknown native checks contribute to incomplete_checks; not_collected and not_applicable are collection limits. Package-wide version is null, and source_version need not equal an affected release. Retained versions 1 and 2 remain readable; versions 4 and newer remain opaque. Always dispatch on returned schema_version. Results are bounded to 16,777,216 bytes. Pending jobs return 409 ANALYSIS_PENDING. Failed jobs return 409 ANALYSIS_FAILED with a producer failure_code from an open vocabulary and a fixed safe detail; backend diagnostics are not returned. After authentication, malformed, missing, expired and other-owner job IDs produce the same 404 ANALYSIS_NOT_FOUND response; 400 remains for other invalid request syntax.
curl --request GET \
--url https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"coverage": {
"deprecation": {
"candidates_count": 2,
"checked_count": 1,
"not_collected_count": 0,
"not_collected_registries": [],
"unknown_count": 1
},
"outdated": {
"candidates_count": 2,
"checked_count": 2,
"not_collected_count": 0,
"not_collected_registries": [],
"unknown_count": 0
},
"vulnerabilities": {
"candidates_count": 2,
"checked_count": 1,
"unknown_count": 1,
"unsupported_count": 0,
"unsupported_registries": []
}
},
"findings": {
"deprecated": [
{
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "1.0.0"
},
"paths": [
"a/package-lock.json"
],
"reason": "synthetic deprecation"
}
],
"duplicates": [
{
"name": "lodash",
"registry": "npm",
"unattributed_requirements": [
{
"path": "a/package.json",
"requested_requirement": "^1.0.0",
"requester": {
"name": "app-1",
"version": null
},
"requirement_status": "recorded",
"target_status": "untargeted"
}
],
"versions": [
{
"origins": [
{
"path": "a/package-lock.json",
"requested_requirement": "^1.0.0",
"requester": {
"name": "app-1",
"version": null
},
"status": "recorded"
}
],
"paths": [
"a/package-lock.json"
],
"version": "1.0.0"
},
{
"origins": [
{
"path": "b/package-lock.json",
"requested_requirement": null,
"requester": {
"name": "app-2",
"version": null
},
"status": "requirement_not_recorded"
}
],
"paths": [
"b/package-lock.json"
],
"version": "2.0.0"
}
]
}
],
"outdated": [
{
"change_type": "major",
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "1.0.0"
},
"latest_version": "2.0.0",
"paths": [
"a/package-lock.json"
]
}
],
"vulnerabilities": [
{
"advisory_id": "SYNTHETIC-1",
"aliases": [],
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "1.0.0"
},
"fixed_in_versions": [
"2.0.0"
],
"malicious": false,
"matched_ranges": [
"<2.0.0"
],
"paths": [
"a/package-lock.json"
],
"related_advisory_ids": [],
"severity_score": null,
"severity_type": null,
"summary": null,
"verified_remedies": []
}
]
},
"generated_at": "2026-10-14T00:00:00Z",
"notices": [
"Checks use the locally available advisory corpus and package metadata; unchecked evidence stays explicit.",
"This is a conditional pre-build inventory, not an observed installation or a constraint-conflict analysis.",
"File paths locate evidence. Manifest associations do not establish package reachability.",
"Verified remedies cover all selected advisory evidence for one exact coordinate, not caller constraints."
],
"schema_version": 2,
"summary": {
"dependencies": 2,
"deprecated": 1,
"duplicates": 1,
"excluded_dependencies": 1,
"incomplete_checks": 2,
"incomplete_sources": 1,
"outdated": 1,
"vulnerabilities": 1
},
"unknowns": {
"excluded_dependencies": [
{
"name": "private-git",
"paths": [
"a/package-lock.json"
],
"reason": "non_registry_source",
"version": null
}
],
"metadata": [
{
"check": "deprecation",
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "2.0.0"
},
"paths": [
"b/package-lock.json"
],
"reason": "lookup_failed",
"status": "unknown"
}
],
"resolution": [
{
"name": null,
"path": "a/package.json",
"reason": "incomplete_dependency_list"
}
],
"sources": [
{
"path": "a/package-lock.json",
"reasons": [
"inventory_only"
]
}
],
"vulnerabilities": [
{
"advisory_ids": [],
"check": "vulnerabilities",
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "2.0.0"
},
"paths": [
"b/package-lock.json"
],
"reasons": [
"assessment_unavailable"
],
"status": "unknown"
}
]
}
}Authorizations
Headers
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.
1 - 64^[A-Za-z0-9_-]{1,64}$Path Parameters
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.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
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.
curl --request GET \
--url https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/result")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"coverage": {
"deprecation": {
"candidates_count": 2,
"checked_count": 1,
"not_collected_count": 0,
"not_collected_registries": [],
"unknown_count": 1
},
"outdated": {
"candidates_count": 2,
"checked_count": 2,
"not_collected_count": 0,
"not_collected_registries": [],
"unknown_count": 0
},
"vulnerabilities": {
"candidates_count": 2,
"checked_count": 1,
"unknown_count": 1,
"unsupported_count": 0,
"unsupported_registries": []
}
},
"findings": {
"deprecated": [
{
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "1.0.0"
},
"paths": [
"a/package-lock.json"
],
"reason": "synthetic deprecation"
}
],
"duplicates": [
{
"name": "lodash",
"registry": "npm",
"unattributed_requirements": [
{
"path": "a/package.json",
"requested_requirement": "^1.0.0",
"requester": {
"name": "app-1",
"version": null
},
"requirement_status": "recorded",
"target_status": "untargeted"
}
],
"versions": [
{
"origins": [
{
"path": "a/package-lock.json",
"requested_requirement": "^1.0.0",
"requester": {
"name": "app-1",
"version": null
},
"status": "recorded"
}
],
"paths": [
"a/package-lock.json"
],
"version": "1.0.0"
},
{
"origins": [
{
"path": "b/package-lock.json",
"requested_requirement": null,
"requester": {
"name": "app-2",
"version": null
},
"status": "requirement_not_recorded"
}
],
"paths": [
"b/package-lock.json"
],
"version": "2.0.0"
}
]
}
],
"outdated": [
{
"change_type": "major",
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "1.0.0"
},
"latest_version": "2.0.0",
"paths": [
"a/package-lock.json"
]
}
],
"vulnerabilities": [
{
"advisory_id": "SYNTHETIC-1",
"aliases": [],
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "1.0.0"
},
"fixed_in_versions": [
"2.0.0"
],
"malicious": false,
"matched_ranges": [
"<2.0.0"
],
"paths": [
"a/package-lock.json"
],
"related_advisory_ids": [],
"severity_score": null,
"severity_type": null,
"summary": null,
"verified_remedies": []
}
]
},
"generated_at": "2026-10-14T00:00:00Z",
"notices": [
"Checks use the locally available advisory corpus and package metadata; unchecked evidence stays explicit.",
"This is a conditional pre-build inventory, not an observed installation or a constraint-conflict analysis.",
"File paths locate evidence. Manifest associations do not establish package reachability.",
"Verified remedies cover all selected advisory evidence for one exact coordinate, not caller constraints."
],
"schema_version": 2,
"summary": {
"dependencies": 2,
"deprecated": 1,
"duplicates": 1,
"excluded_dependencies": 1,
"incomplete_checks": 2,
"incomplete_sources": 1,
"outdated": 1,
"vulnerabilities": 1
},
"unknowns": {
"excluded_dependencies": [
{
"name": "private-git",
"paths": [
"a/package-lock.json"
],
"reason": "non_registry_source",
"version": null
}
],
"metadata": [
{
"check": "deprecation",
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "2.0.0"
},
"paths": [
"b/package-lock.json"
],
"reason": "lookup_failed",
"status": "unknown"
}
],
"resolution": [
{
"name": null,
"path": "a/package.json",
"reason": "incomplete_dependency_list"
}
],
"sources": [
{
"path": "a/package-lock.json",
"reasons": [
"inventory_only"
]
}
],
"vulnerabilities": [
{
"advisory_ids": [],
"check": "vulnerabilities",
"coordinate": {
"name": "lodash",
"registry": "npm",
"version": "2.0.0"
},
"paths": [
"b/package-lock.json"
],
"reasons": [
"assessment_unavailable"
],
"status": "unknown"
}
]
}
}