githubEdit

Findings

circle-info

This document uses the REST API. For more details, see the Authentication for API page.

List findings for a test. (Early Access)

get

List findings for a test.

Test Findings are scanner-agnostic representations of vulnerabilities and organization-level policy breaches. When Snyk runs a Test, the results of that Test are formatted into Findings.

This endpoint returns pages of Findings associated with a given Test ID. Findings are returned in sorted order by ID, with page size equal to the provided Limit query parameter. Page size is 10 Findings by default if no parameter is provided.

Note that the Findings returned from this endpoint are only the Findings that are not suppressed by policy and are not in violation of a set Test threshold (like Severity or Risk Score).

To retrieve the next (or previous) page of Findings, utilize the Next and Prev links returned in the response.

Required permissions

  • View Organization (org.read)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
org_idstring · uuidRequired

Snyk Org ID under which to run or query information about a Job or Test.

test_idstring · uuidRequired

Test ID returned from the Test API to query.

Query parameters
versionstringRequired

The API version requested.

starting_afterstringOptional

Opaque pagination cursor for forward traversal.

ending_beforestringOptional

Opaque pagination cursor for reverse traversal.

limitinteger · int8 · min: 1 · max: 100Optional

The number of items to return.

Default: 10
Header parameters
snyk-request-idstring · uuidOptional

A unique ID assigned to each API request, for tracing and troubleshooting.

Snyk clients can optionally provide this ID.

snyk-interaction-idstring · min: 36 · max: 128Optional

Identifies the Snyk client interaction in which this API request occurs.

The identifier is an opaque string. though at the time of writing it may either be a uuid or a urn containing a uuid and some metadata.

Responses
chevron-right
200

Successful API response for a paginated collection.

application/vnd.api+json
get
/orgs/{org_id}/tests/{test_id}/findings

Last updated

Was this helpful?