Stackurity Start free trial

API reference VEX

VEX

10 operations. Base URL https://app.stackurity.dev/api/v1 on Stackurity Cloud; see authentication.

Imported VEX documents

GET /vex/documents

Role: viewer

Imported documents, newest first, paged

Parameters

ParameterInTypeDescription
limitquerystring
offsetquerystring

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

One imported VEX document

GET /vex/documents/{id}

Role: viewer

One document

Parameters

ParameterInTypeDescription
id requiredpathstring

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Approve or decline a VEX document's pending statements

POST /vex/documents/{id}/decision

Role: security

{"decision": "approve" | "decline", "note": "..."} for every pending request of the document; organisation-wide security or admin only

Parameters

ParameterInTypeDescription
id requiredpathstring

Request body

application/json, required: object

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

A VEX document's statements

GET /vex/documents/{id}/statements

Role: viewer

Statements with what each matched, its problems and its approval request. outcome: matched, unmatched or pending

Parameters

ParameterInTypeDescription
id requiredpathstring
outcomequerystring
limitquerystring
offsetquerystring

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Export decisions as VEX

GET /vex/export

Role: viewer

False positives, mitigations and imported statements about open issues. format: openvex (default) or cyclonedx; asset_id or project_id narrows it

Parameters

ParameterInTypeDescription
formatquerystring
asset_idquerystring
project_idquerystring

Responses

StatusMeaningBody
2XXThe documentstring (application/octet-stream)
4XXAn errorError
5XXAn errorError

Import a VEX document

POST /vex/import

Role: engineer+

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

ParameterInTypeDescription
source_idquerystring
asset_idquerystring
project_idquerystring
filenamequerystring

Request body

application/json, required: object

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

VEX sources

GET /vex/sources

Role: security

Sources and how far each is trusted

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Add a VEX source

POST /vex/sources

Role: admin

name, auto_apply, token_id, public_key (PEM). auto_apply needs a public key or a token

Request body

application/json, required: object

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Change a VEX source

PATCH /vex/sources/{id}

Role: admin

Changes the fields sent; token_id: 0 and public_key: "" remove a pin

Parameters

ParameterInTypeDescription
id requiredpathstring

Request body

application/json, required: object

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Remove a VEX source

DELETE /vex/sources/{id}

Role: admin

Its documents keep its name

Parameters

ParameterInTypeDescription
id requiredpathstring

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError