/v2/issues

put

https://app.fossa.com/api/v2/issues

Apply actions to the current selection of issues or set of applied filters. Note that Issue Exports are only allowed for premium users.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

category

string

enum

required

Issue category

Allowed:

status

string

enum

Issue status

Allowed:

scope[type]

string

enum

required

Scope of issues to view / update

Allowed:

scope[id]

string

Project or release group ID (required when scope[type] is "project" or "releaseGroup")

scope[revision]

string

Revision ID (when scope[type] is "project")

scope[revisionScanId]

int32

Revision scan ID (when scope[type] is "project")

scope[release]

string

Release group ID (when scope[type] is "releaseGroup")

scope[releaseScanId]

string

Release scan ID (when scope[type] is "releaseGroup")

scope[compareTo][revision]

string

The revision ID to compare issues with. Only available for Project Scope.

scope[compareTo][changeStatus]

string

enum

The status of issues to fetch when comparing issues. - New issues are present in the current revision but not in the comparison revision. - Remediated issues are present in the comparison revision but not in the current revision. - Unchanged issues are present in both revisions. Only available for Project Scope.

Allowed:

ids[]

array of integers

Filter by specific issue IDs

ids[]

filter[revisionIds][]

array of strings

Filter by specific revision IDs

filter[revisionIds][]

filter[search]

string

Filter by package name or CVE (when category is "vulnerability")

filter[depths][]

array of strings

Filter by issue depth

filter[depths][]

Allowed:

filter[ticketed][]

array of strings

Filter by ticketed status. Only available to premium users.

filter[ticketed][]

Allowed:

filter[containerLayers][]

array of strings

Filter by container layer

filter[containerLayers][]

Allowed:

filter[type][]

Filter by licensing issue type (when category is "licensing") or quality issue type (when category is "quality")

filter[packageManagers][]

array of strings

Filter by specific package managers

filter[packageManagers][]

filter[projectLabels][]

array of strings

Filter by specific project labels

filter[projectLabels][]

filter[identification][]

array of strings

Filter by license identification (when category is "licensing")

filter[identification][]

Allowed:

filter[severity][]

array of strings

Filter by vuln severity (when category is "vulnerability")

filter[severity][]

Allowed:

filter[severitySource][]

array of strings

Filter by severity source (when category is "vulnerability"). Use 'standard' to filter by CVSS score, 'custom' to filter by custom risk score. When both are provided, issues matching either source are returned. Defaults to 'standard' when not provided. Custom risk score filtering is not available for global scope.

filter[severitySource][]

Allowed:

filter[foundAfter]

date-time

Include only issues found on after a given ISO timestamp. Only available to premium users

filter[hasFix][]

array of strings

Filter by vuln fixability (when category is "vulnerability")

filter[hasFix][]

Allowed:

filter[upgradeDistance][]

array of strings

Filter by vuln upgrade distance (when category is "vulnerability")

filter[upgradeDistance][]

Allowed:

filter[exploitMaturity][]

array of strings

Filter by vuln exploit maturity (when category is "vulnerability")

filter[exploitMaturity][]

Allowed:

filter[ignoreReason][]

array of strings

Filter by vuln ignore reason (when category is "vulnerability") This value appears in the vulnerabilities.analysis.detail field in CycloneDX SBOM reports

filter[ignoreReason][]

filter[licenses][]

array of strings

Filter by issues affected by a set of license ID's (when category is "licensing")

filter[licenses][]

filter[confidence][]

array of strings

Filter issues by their binary dependency confidence level(s)

filter[confidence][]

Allowed:

filter[issueSource][]

Filter by issue source. Use 'dependency' and 'snippet' to filter by whether the issue comes from a dependency or a code snippet. When the vendored dependency detection feature is enabled, use 'managed-dependency' and 'vendored-dependency' to filter dependency issues by whether the dependency is managed or vendored.

filter[cvssAttackVector][]

array of strings

Filter by CVSS attack vector (when category is "vulnerability")

filter[cvssAttackVector][]

Allowed:

filter[cvssAttackComplexity][]

array of strings

Filter by CVSS attack complexity (when category is "vulnerability"). For CVSS v4, this includes the Attack Requirements (AT) metric.

filter[cvssAttackComplexity][]

Allowed:

filter[cvssPrivilegesRequired][]

array of strings

Filter by CVSS privileges required (when category is "vulnerability")

filter[cvssPrivilegesRequired][]

Allowed:

Body Params

type

string

enum

Allowed:

notes

string

reason

string

Responses

200Count of affected issues

400Bad Request

403Forbidden