GET/v1/violation

Returns a list of all policy violations for the entire portfolio

Requires permission VIEW_POLICY_VIOLATION

16 parameters
pageNumberstringoptional
The page to return. To be used in conjunction with <code>pageSize</code>.
Default:1
pageSizestringoptional
Number of elements to return per page. To be used in conjunction with <code>pageNumber</code>.
Default:100
offsetstringoptional
Offset to start returning elements from. To be used in conjunction with <code>limit</code>.
limitstringoptional
Number of elements to return per page. To be used in conjunction with <code>offset</code>.
sortNamestringoptional
Name of the resource field to sort on.
sortOrderstringoptional
Ordering of items when sorting with <code>sortName</code>.
Allowed:asc, desc
suppressedbooleanoptional
Optionally includes suppressed violations
showInactivebooleanoptional
Optionally includes inactive projects
violationStatestringoptional
Filter by violation state
riskTypestringoptional
Filter by risk type
policystringoptional
Filter by policy
analysisStatestringoptional
Filter by analysis state
occurredOnDateFromstringoptional
Filter occurred on from
occurredOnDateTostringoptional
Filter occurred on to
textSearchFieldstringoptional
Filter the text input in these fields
textSearchInputstringoptional
Filter by this text input

2 status codes
200A list of all policy violations for the entire portfolio
analysisobjectoptional
componentobjectoptional
policyConditionobjectoptional
projectobjectoptional
textstringoptional
timestampintegerrequired
UNIX epoch timestamp in milliseconds
typestringoptional
Allowed:LICENSESECURITYOPERATIONAL
uuidstringrequired
401Unauthorized

Error handling

A 401 is returned: Unauthorized.