Skip to main content
POST
Compare two dependency snapshots

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

Body

multipart/form-data
request
string
required

JSON string conforming to DependencyDiffRequest. All controls required. groups accepts all alone or native group selectors; unlocked_manifests is resolve or recorded_only. No gateway dependency parser or resolver is run.

Example:

"{\n \"schema_version\": 1,\n \"base\": {\n \"state\": \"supplied\"\n },\n \"head\": {\n \"state\": \"supplied\"\n },\n \"selection\": {\n \"groups\": [\n \"all\"\n ],\n \"unlocked_manifests\": \"recorded_only\"\n },\n \"analysis\": {\n \"advisories\": true,\n \"direct_reviews\": true\n }\n}\n"

base_files[]
file[]

Repeat for each base file; filename is its repository-relative path. Required and nonempty for supplied, absent for empty.

Maximum array length: 256
head_files[]
file[]

Repeat for each head file; filename is its repository-relative path. Required and nonempty for supplied, absent for empty.

Maximum array length: 256

Response

The upload was admitted and queued for asynchronous analysis.

events_url
string<uri-reference>
required

Canonical relative URL for the job's server-sent event stream.

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

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

expires_at
string<date-time>
required

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

Example:

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

id
string<uuid>
required

Opaque identifier for 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"

result_url
string<uri-reference>
required

Canonical relative URL for retrieving the completed analysis document.

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"

state
string
required

Initial state when the accepted job is placed in the queue. Open response vocabulary; clients must accept unfamiliar values and codes.

Example:

"queued"

status_url
string<uri-reference>
required

Canonical relative URL for the job status snapshot.

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

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