Reach Graph API Reference

Field	Value
Source spec	`reach-graph/openapi/v1.json`
OpenAPI version	`3.1.1`
API version	`1.0.0`
Operations	19
Path filter	All paths

Operations

`GET /api/v1/buildinfo`

API alias for /buildinfo.json (same payload).

Property	Value
Operation ID	`StellaOpsBuildInfoApi`
Tags	`StellaOps.ReachGraph.WebService`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	-

`GET /buildinfo.json`

Image build provenance (module, gitSha, gitCommitTime, imageBuiltAt, branch) for drift detection.

Property	Value
Operation ID	`StellaOpsBuildInfoFile`
Tags	`StellaOps.ReachGraph.WebService`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	-

`POST /v1/cve-mappings`

Property	Value
Operation ID	-
Tags	`CveMapping`
Auth	Not declared
Request body	`application/*+json`, `application/json`, `text/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`201`	Created	`application/json`
`400`	Bad Request	`application/json`

`POST /v1/cve-mappings/analyze-patch`

Property	Value
Operation ID	-
Tags	`CveMapping`
Auth	Not declared
Request body	`application/*+json`, `application/json`, `text/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`400`	Bad Request	`application/json`

`GET /v1/cve-mappings/by-package`

Property	Value
Operation ID	-
Tags	`CveMapping`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`purl`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	`application/json`

`GET /v1/cve-mappings/by-symbol`

Property	Value
Operation ID	-
Tags	`CveMapping`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`language`	`query`	no
`symbol`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	`application/json`

`GET /v1/cve-mappings/stats`

Property	Value
Operation ID	-
Tags	`CveMapping`
Auth	Not declared
Request body	-

Responses:

Status	Description	Content types
`200`	OK	`application/json`

`GET /v1/cve-mappings/{cveId}`

Property	Value
Operation ID	-
Tags	`CveMapping`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`cveId`	`path`	yes

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`404`	Not Found	`application/json`

`POST /v1/cve-mappings/{cveId}/enrich`

Property	Value
Operation ID	-
Tags	`CveMapping`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`cveId`	`path`	yes

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`404`	Not Found	`application/json`

`POST /v1/reachability/batch`

Property	Value
Operation ID	-
Tags	`Reachability`
Auth	Not declared
Request body	`application/*+json`, `application/json`, `text/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`400`	Bad Request	`application/json`

`POST /v1/reachability/hybrid`

Property	Value
Operation ID	-
Tags	`Reachability`
Auth	Not declared
Request body	`application/*+json`, `application/json`, `text/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`400`	Bad Request	`application/json`

`POST /v1/reachability/runtime`

Property	Value
Operation ID	-
Tags	`Reachability`
Auth	Not declared
Request body	`application/*+json`, `application/json`, `text/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`400`	Bad Request	`application/json`

`POST /v1/reachability/static`

Property	Value
Operation ID	-
Tags	`Reachability`
Auth	Not declared
Request body	`application/*+json`, `application/json`, `text/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`400`	Bad Request	`application/json`
`404`	Not Found	`application/json`

`POST /v1/reachgraphs`

Property	Value
Operation ID	-
Tags	`ReachGraph`
Auth	Not declared
Request body	`application/*+json`, `application/json`, `text/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`201`	Created	`application/json`
`400`	Bad Request	`application/json`
`401`	Unauthorized	`application/json`
`429`	Too Many Requests	`application/json`

`GET /v1/reachgraphs/by-artifact/{artifactDigest}`

Property	Value
Operation ID	-
Tags	`ReachGraph`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`artifactDigest`	`path`	yes
`limit`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	`application/json`

`POST /v1/reachgraphs/replay`

Property	Value
Operation ID	-
Tags	`ReachGraph`
Auth	Not declared
Request body	`application/*+json`, `application/json`, `text/json`

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`400`	Bad Request	`application/json`

`GET /v1/reachgraphs/{digest}`

Property	Value
Operation ID	-
Tags	`ReachGraph`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`digest`	`path`	yes

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`404`	Not Found	`application/json`

`DELETE /v1/reachgraphs/{digest}`

Property	Value
Operation ID	-
Tags	`ReachGraph`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required	Description
`digest`	`path`	yes

Responses:

Status	Description	Content types
`204`	No Content	`application/json`
`403`	Forbidden	`application/json`
`404`	Not Found	`application/json`

`GET /v1/reachgraphs/{digest}/slice`

Property	Value
Operation ID	-
Tags	`ReachGraph`
Auth	Not declared
Request body	-

Parameters:

Name	In	Required
`digest`	`path`	yes
`cve`	`query`	no
`depth`	`query`	no
`direction`	`query`	no
`entrypoint`	`query`	no
`file`	`query`	no
`q`	`query`	no

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`404`	Not Found	`application/json`