Binary Index API Reference

Field	Value
Source spec	`binary-index/openapi/v1.json`
OpenAPI version	`3.1.1`
API version	`1.0.0`
Operations	17
Path filter	All paths

Operations

`GET /api/v1/buildinfo`

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

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

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/v1/golden-sets`

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

Parameters:

Name	In	Required
`component`	`query`	no
`limit`	`query`	no
`offset`	`query`	no
`orderBy`	`query`	no
`status`	`query`	no
`tags`	`query`	no

Responses:

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

`POST /api/v1/golden-sets`

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

Responses:

Status	Description	Content types
`201`	Created	`application/json`
`400`	Bad Request	`application/json`
`409`	Conflict	`application/json`

`GET /api/v1/golden-sets/{id}`

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

Parameters:

Name	In	Required	Description
`id`	`path`	yes

Responses:

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

`DELETE /api/v1/golden-sets/{id}`

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

Parameters:

Name	In	Required	Description
`id`	`path`	yes

Responses:

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

`GET /api/v1/golden-sets/{id}/audit`

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

Parameters:

Name	In	Required	Description
`id`	`path`	yes

Responses:

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

`PATCH /api/v1/golden-sets/{id}/status`

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

Parameters:

Name	In	Required	Description
`id`	`path`	yes

Responses:

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

`POST /api/v1/ops/binaryindex/bench/run`

Property	Value
Operation ID	-
Tags	`BinaryIndexOps`
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 /api/v1/ops/binaryindex/cache`

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

Responses:

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

`GET /api/v1/ops/binaryindex/config`

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

Responses:

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

`GET /api/v1/ops/binaryindex/health`

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

Responses:

Status	Description	Content types
`200`	OK	`application/json`
`503`	Service Unavailable	`application/json`

`POST /api/v1/resolve/vuln`

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

Parameters:

Name	In	Required	Description
`bypassCache`	`query`	no

Responses:

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

`POST /api/v1/resolve/vuln/batch`

Property	Value
Operation ID	-
Tags	`Resolution`
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`
`500`	Internal Server Error	`application/json`

`GET /api/v1/stats/patch-coverage`

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

Parameters:

Name	In	Required
`cve`	`query`	no
`limit`	`query`	no
`offset`	`query`	no
`package`	`query`	no

Responses:

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

`GET /api/v1/stats/patch-coverage/{cveId}/details`

Property	Value
Operation ID	-
Tags	`PatchCoverage`
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`

`GET /api/v1/stats/patch-coverage/{cveId}/matches`

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

Parameters:

Name	In	Required
`cveId`	`path`	yes
`limit`	`query`	no
`offset`	`query`	no
`state`	`query`	no
`symbol`	`query`	no

Responses:

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

`GET /buildinfo.json`

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

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

Responses:

Status	Description	Content types
`200`	OK	-