v1

latestOpenAPI 3.0.32026-07-134103031.5 MB

Findings

List Account's Findings

get/findings/

Query parameters

approval_datestring date nullable

Date of when the accepted vulnerability was approved.
For example, "2023-08-09"

assigneestring[]

A unique Base58 value identifying this object.

changed_afterstring date-time

Date and time of when the vulnerability was changed, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

changed_beforestring date-time

Date and time of when the vulnerability was changed, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

expiration_datestring date nullable

Date of when the accepted vulnerability expires before changing back to not fixed.
For example, "2023-08-09"

idinteger[]

include'last_found_scan'

Extra fields to include in response:

last_found_scan - Add last_found_scan to response under last_found_scan key

is_id_404_validationboolean

If true, triggers custom response for id filter validation.
If any id filter is invalid, returns a 404 with the following content:

{
    "detail": "Not Found",
    "is_id_404_validation": true,
    "invalid_ids": [
        "9vebyEVLNoZX",
        "6CuzJtJmMp48"
    ]
}

labelstring[]

A unique Base58 value identifying this object.

label_logical_operator'and' | 'or'

Logical operator to apply between labels:
(Defaults to or)

and - and
or - or

lastfound_afterstring date-time

Date and time of when the vulnerability was last found to filter results, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

lastfound_beforestring date-time

Date and time of when the vulnerability was last found to filter results, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

lengthinteger

Number of results to return per page.

newboolean

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

review_statusstring[]

Some findings we're unsure are valid and need a manual validation step.

notrequired - not required
pending - pending review
rejected - rejected after review
accepted - accepted after review

scanstring[]

A unique Base58 value identifying this object.

searchstring

A search term.

severityinteger[]

Severity of the vulnerability finding:

10 - low
20 - medium
30 - high
40 - critical

snyk_sastboolean

statestring[]

State of the vulnerability finding:
(Read more about the meaning of vulnerability findings states)

notfixed - Not Fixed
invalid - Invalid
accepted - Accepted
fixed - Fixed
retesting - Re-testing

targetstring[]

A unique Base58 value identifying this object.

target_labelstring[]

A unique Base58 value identifying this object.

target_label_logical_operator'and' | 'or'

Logical operator to apply between target labels:
(Defaults to or)

and - and
or - or

teamstring[]

A unique Base58 value identifying this object.

Response

countinteger

Total number of results.

page_totalinteger

Total number of pages.

pageinteger

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

lengthinteger

Number of results returned per page.

Example response

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10
}