Sign in
IssuesService

List Issue Groups

Search and group issues by rule with filtering and pagination

post/api/agent/deployments/{deploymentId}/issues/search

Path parameters

deploymentIdstring required

Specifies the deployment to which the issues belong.

Request body

deploymentIdstring

Specifies the deployment to which the issues belong.

issueType'ISSUE_TYPE_SAST' | 'ISSUE_TYPE_SCA' | 'ISSUE_TYPE_SECRETS' | 'ISSUE_TYPE_RESEARCH' | 'ISSUE_TYPE_AI_SAST' enum

Deprecated: use issue_types instead. Filters issues to those with the specified type.

valuedescription
ISSUE_TYPE_SASTDetected by Code rules
ISSUE_TYPE_SCADetected by Supply Chain rules
ISSUE_TYPE_SECRETSDetected by Secrets rules
ISSUE_TYPE_RESEARCHDetected by research rules or scanners
ISSUE_TYPE_AI_SASTDetected by AI detection code scanning
groupBy'GROUP_BY_RULE' enum

Specifies how to group the issues in the response.

valuedescription
GROUP_BY_RULE
limitinteger

Sets the page size of the paginated list of issues.

cursorstring

Cursor used for pagination -- passing no value or an empty string effectively requests the first page.

sortBy'SORT_BY_ISSUE_COUNTS' | 'SORT_BY_SEVERITY' enum

Specifies how to sort the issue groups.

valuedescription
SORT_BY_ISSUE_COUNTS
SORT_BY_SEVERITY
sortDirection'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC' enum

Specifies the direction to sort the results.

valuedescription
SORT_DIRECTION_ASC
SORT_DIRECTION_DESC
issueTypesstring[]

Filters issues to those with any of the specified types (based on the product which produced these issues). When empty, falls back to the deprecated issue_type field for backward compatibility.

valuedescription
ISSUE_TYPE_SASTDetected by Code rules
ISSUE_TYPE_SCADetected by Supply Chain rules
ISSUE_TYPE_SECRETSDetected by Secrets rules
ISSUE_TYPE_RESEARCHDetected by research rules or scanners
ISSUE_TYPE_AI_SASTDetected by AI detection code scanning

Response

OK

cursorstring
totalstring
fetchedstring

Changes