Skip to main content
GET
Get lockfile analysis status

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

Latest full snapshot of the job.

The complete current projection of a lockfile analysis job. Each event is a full replacement snapshot. Revision values are nondecreasing but not unique; apply every snapshot, including state or attempt changes at an equal revision, and do not deduplicate by job ID or revision.

attempt
integer
required

Current execution attempt number; it may change while the revision remains equal.

Required range: x >= 0
Example:

1

counts
object
required

Stage-dependent progress counters. Fields are optional and omitted until the corresponding stage provides a value.

error
enum<string> | null
required

Allowlisted terminal failure code, or null when no terminal error is recorded. Internal diagnostics are never included.

Available options:
resolution_timeout,
resolution_failed,
output_too_large,
unrepresentable_spdx,
parser_contract_changed,
execution_failed,
execution_record_unavailable,
invalid_response,
no_manifest_evidence
expires_at
string<date-time>
required

Time after which the job and its result are no longer available.

Example:

"2026-10-10T12:00:00Z"

format
enum<string>
required

Requested output format for the completed document.

Available options:
cyclonedx,
spdx,
text
id
string<uuid>
required

Opaque UUID identifying this analysis job.

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}$
Example:

"01900000-0000-7000-8000-000000000001"

kind
enum<string>
required

Analysis kind; this experimental job endpoint currently supports SBOM analysis only.

Available options:
sbom
Example:

"sbom"

phase
enum<string>
required

Current analysis stage.

Available options:
queued,
resolving,
enriching,
rendering,
succeeded,
failed
Example:

"enriching"

result_url
string<uri-reference>
required

Canonical relative URL for retrieving the result. This field is always present; only state=succeeded indicates that the result is ready.

Pattern: ^/v1/experimental/lockfile-jobs/[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}/result$
Example:

"/v1/experimental/lockfile-jobs/01900000-0000-7000-8000-000000000001/result"

revision
integer
required

Nondecreasing job revision. Distinct full snapshots may share a revision, so it is not an event deduplication key.

Required range: x >= 0
Example:

3

state
enum<string>
required

Current job state. The result is ready only when state is succeeded.

Available options:
queued,
running,
succeeded,
failed
Example:

"running"