v1

latestOpenAPI 3.0.02026-07-249055687.1 KB

diff-scans

Get diff scan

Get the difference between two full scans from an existing diff scan resource.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

diff-scans:list

get/orgs/{org_slug}/diff-scans/{diff_scan_id}

Path parameters

org_slugstring required

The slug of the organization

diff_scan_idstring uuid required

The ID of the diff scan

Query parameters

omit_license_detailsboolean

Omit license details in the response. This can reduce the size of the response significantly, but will not include license information for the artifacts.

omit_unchangedboolean

Omit unchanged artifacts from the response. When set to true, the unchanged field will be set to null.

cachedboolean

Return cached immutable scan results. When enabled and results are cached, returns the pre-computed scan. When results are not yet cached, returns 202 Accepted and enqueues a background job. Note: When cached=true, the omit_license_details parameter is ignored as cached results always includes license details.

Response

The difference between the two Full Scans in the diff scan.