Vex Hub API Reference

Field	Value
Source spec	`vex-hub/openapi/v1.json`
OpenAPI version	`3.1.1`
API version	`1.0.0`
Operations	26
Path filter	All paths

Operations

`GET /api/v1/agents`

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

Parameters:

Name	In	Required	Description
`healthy_only`	`query`	no
`platform`	`query`	no

Responses:

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

`POST /api/v1/agents/register`

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

`GET /api/v1/agents/{agentId}`

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

Parameters:

Name	In	Required	Description
`agentId`	`path`	yes

Responses:

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

`DELETE /api/v1/agents/{agentId}`

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

Parameters:

Name	In	Required	Description
`agentId`	`path`	yes

Responses:

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

`POST /api/v1/agents/{agentId}/commands`

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

Parameters:

Name	In	Required	Description
`agentId`	`path`	yes

Responses:

Status	Description	Content types
`202`	Accepted	`application/json`
`404`	Not Found	`application/json`

`POST /api/v1/agents/{agentId}/facts`

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

Parameters:

Name	In	Required	Description
`agentId`	`path`	yes

Responses:

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

`POST /api/v1/agents/{agentId}/heartbeat`

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

Parameters:

Name	In	Required	Description
`agentId`	`path`	yes

Responses:

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

`PATCH /api/v1/agents/{agentId}/posture`

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

Parameters:

Name	In	Required	Description
`agentId`	`path`	yes

Responses:

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

`GET /api/v1/buildinfo`

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

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

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/v1/signals/hot-symbols`

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

Parameters:

Name	In	Required
`build_id`	`query`	no
`function`	`query`	no
`image`	`query`	yes
`limit`	`query`	no
`min_count`	`query`	no
`module`	`query`	no
`offset`	`query`	no
`security_only`	`query`	no
`sort`	`query`	no
`window_hours`	`query`	no

Responses:

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

`GET /api/v1/signals/hot-symbols/correlated`

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

Parameters:

Name	In	Required	Description
`image`	`query`	yes

Responses:

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

`GET /api/v1/signals/hot-symbols/stats`

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

Parameters:

Name	In	Required	Description
`image`	`query`	yes

Responses:

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

`GET /api/v1/signals/hot-symbols/top`

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

Parameters:

Name	In	Required
`image`	`query`	yes
`top`	`query`	no
`window_hours`	`query`	no

Responses:

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

`POST /api/v1/vex/conflicts/resolve`

Resolves open VEX conflicts for the selected vulnerability-product pair using the chosen authoritative statement.

Property	Value
Operation ID	`ResolveVexConflict`
Tags	`VEX`
Auth	Not declared
Request body	`application/json`

Responses:

Status	Description	Content types
`204`	No Content	-
`400`	Bad Request	-
`404`	Not Found	-

`GET /api/v1/vex/cve/{cveId}`

Get VEX statements for a CVE ID

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

Parameters:

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

Responses:

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

`GET /api/v1/vex/export`

Export VEX statements in OpenVEX format

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

Responses:

Status	Description	Content types
`200`	OK	-

`GET /api/v1/vex/index`

Get VEX hub index manifest for tool integration

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

Responses:

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

`GET /api/v1/vex/package/{purl}`

Get VEX statements for a package PURL

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

Parameters:

Name	In	Required
`purl`	`path`	yes
`limit`	`query`	no
`offset`	`query`	no

Responses:

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

`GET /api/v1/vex/search`

Search VEX statements with filters

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

Parameters:

Name	In	Required
`isFlagged`	`query`	no
`limit`	`query`	no
`offset`	`query`	no
`productKey`	`query`	no
`sourceId`	`query`	no
`status`	`query`	no
`vulnerabilityId`	`query`	no

Responses:

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

`GET /api/v1/vex/source/{sourceId}`

Get VEX statements from a specific source

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

Parameters:

Name	In	Required
`sourceId`	`path`	yes
`limit`	`query`	no
`offset`	`query`	no

Responses:

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

`GET /api/v1/vex/statement/{id}`

Get a specific VEX statement by ID

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

`GET /api/v1/vex/stats`

Get VEX hub statistics

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

Responses:

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

`GET /buildinfo.json`

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

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

Responses:

Status	Description	Content types
`200`	OK	-

`GET /health`

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

Responses:

Status	Description	Content types
`200`	OK	-

`GET /health/liveness`

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

Responses:

Status	Description	Content types
`200`	OK	-

`GET /health/readiness`

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

Responses:

Status	Description	Content types
`200`	OK	-