Experimental
Stream lockfile analysis progress
Open the public event stream for an authorized job. Each frame uses event: snapshot, id: <revision>, and data: <JSON LockfileJobSnapshot>; the data is a complete state replacement and contains the canonical result_url. Revisions are nondecreasing but nonunique: equal-revision snapshots may change state or attempt, so apply every frame and never deduplicate by job ID or revision. A fresh connection starts with the latest full snapshot; Last-Event-ID does not replay history. Idle connections receive the : keepalive comment every 15 seconds, and the public connection closes after 600 seconds or immediately after a terminal snapshot. After receiving a succeeded or failed snapshot, clients must close the connection and stop reconnecting; browser EventSource clients should call close(), because EventSource otherwise reconnects automatically. Reconnect to continue an unfinished job. Closing the downstream connection releases this stream's upstream transport but does not cancel the job. After authentication, malformed, missing, expired and other-owner job IDs return the same 404 ANALYSIS_NOT_FOUND response; 400 remains for other invalid request syntax. Authentication, ownership, and upstream opening errors are returned before event-stream headers; a later stream error closes the body without appending problem JSON. The upstream stream has no HTTP whole-body deadline, while the public event protocol has the 600-second lifetime.
GET
/
v1
/
experimental
/
lockfile-jobs
/
{id}
/
events
Stream lockfile analysis progress
curl --request GET \
--url https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/events"
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}/events', 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}/events",
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}/events"
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}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/events")
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_bodyevent: snapshot
id: 3
data: {"id":"01900000-0000-7000-8000-000000000001","kind":"sbom","format":"cyclonedx","state":"running","attempt":1,"phase":"enriching","counts":{"manifests_done":2,"manifests_total":2,"resolved":37,"queued_packages":9,"coordinates_done":18,"coordinates_total":37,"cached":7,"fetched":11,"fetch_failed":0},"error":null,"result_url":"/v1/experimental/lockfile-jobs/01900000-0000-7000-8000-000000000001/result","expires_at":"2026-10-10T12:00:00Z","revision":3}
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.
Required string length:
1 - 64Pattern:
^[A-Za-z0-9_-]{1,64}$Path Parameters
Response
Server-sent event stream. Each snapshot frame has event name snapshot, the revision as its event ID, and data containing one complete LockfileJobSnapshot JSON object.
Repeated frames use event: snapshot, id: , and data: , followed by a blank line. Idle keepalive frames are : keepalive SSE comments.
⌘I
Stream lockfile analysis progress
curl --request GET \
--url https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/events"
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}/events', 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}/events",
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}/events"
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}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.githits.dev/v1/experimental/lockfile-jobs/{id}/events")
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_bodyevent: snapshot
id: 3
data: {"id":"01900000-0000-7000-8000-000000000001","kind":"sbom","format":"cyclonedx","state":"running","attempt":1,"phase":"enriching","counts":{"manifests_done":2,"manifests_total":2,"resolved":37,"queued_packages":9,"coordinates_done":18,"coordinates_total":37,"cached":7,"fetched":11,"fetch_failed":0},"error":null,"result_url":"/v1/experimental/lockfile-jobs/01900000-0000-7000-8000-000000000001/result","expires_at":"2026-10-10T12:00:00Z","revision":3}