API reference VEX
VEX
Imported VEX documents
GET /vex/documents
Imported documents, newest first, paged
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
limit | query | string | |
offset | query | string |
Responses
One imported VEX document
GET /vex/documents/{id}
One document
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Responses
Approve or decline a VEX document's pending statements
POST /vex/documents/{id}/decision
{"decision": "approve" | "decline", "note": "..."} for every pending request of the document; organisation-wide security or admin only
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Request body
application/json, required: object
Responses
A VEX document's statements
GET /vex/documents/{id}/statements
Statements with what each matched, its problems and its approval request. outcome: matched, unmatched or pending
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string | |
outcome | query | string | |
limit | query | string | |
offset | query | string |
Responses
Export decisions as VEX
GET /vex/export
False positives, mitigations and imported statements about open issues. format: openvex (default) or cyclonedx; asset_id or project_id narrows it
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
format | query | string | |
asset_id | query | string | |
project_id | query | string |
Responses
Import a VEX document
POST /vex/import
The body is an OpenVEX or CycloneDX VEX document (or a CycloneDX BOM with VEX embedded), plain or as a DSSE envelope or Sigstore bundle; at most 16 MiB. source_id names a source, asset_id or project_id limits matching, filename is recorded. not_affected statements wait in the approval inbox unless the source is trusted to apply and every pin held. Answers what matched, what waits, what applied and why statements did not match
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
source_id | query | string | |
asset_id | query | string | |
project_id | query | string | |
filename | query | string |
Request body
application/json, required: object
Responses
VEX sources
GET /vex/sources
Sources and how far each is trusted
Responses
Add a VEX source
POST /vex/sources
name, auto_apply, token_id, public_key (PEM). auto_apply needs a public key or a token
Request body
application/json, required: object
Responses
Change a VEX source
PATCH /vex/sources/{id}
Changes the fields sent; token_id: 0 and public_key: "" remove a pin
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |
Request body
application/json, required: object
Responses
Remove a VEX source
DELETE /vex/sources/{id}
Its documents keep its name
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
id required | path | string |