Findings

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.

Required permissions

  • View Organization (org.read)
Authorizations
AuthorizationstringRequired

API key value must be prefixed with "Token ".

Path parameters
org_idstring · uuidRequired

The org id

test_idstring · uuidRequired

The test id

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
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?