Skip to main content
PATCH
Close a finding (mark fixed or dismiss as not an issue)

Headers

Authorization
string | null

Bearer token with API key

Path Parameters

finding_id
string
required

Body

application/json

Request body to close a finding.

Every close needs an explanation, and a dismissal also needs a reason code.

status
enum<string>
required

Close action: 'fixed' (resolved) or 'dismissed' (not an issue).

Available options:
fixed,
dismissed
explanation
string
required

Why the finding is being closed. Required for every close: recorded as the fix description when 'fixed' and as the dismissal rationale when 'dismissed'. Maximum 4000 characters.

Required string length: 1 - 4000
reason_code
enum<string> | null

Dismissal category. Required when status is 'dismissed'; ignored otherwise. Allowed values: data_is_public, authenticated_users_only, working_as_designed, mitigated_elsewhere, accepted_risk, false_positive, other.

Available options:
data_is_public,
authenticated_users_only,
working_as_designed,
mitigated_elsewhere,
accepted_risk,
false_positive,
other

Response

Successful Response

One finding, with the attacks that reproduce it in attacks.

finding_id
string
required
lens
enum<string>
required

The kind of testing a finding came from.

Available options:
security,
safety,
quality,
policy
category
string
required
severity
enum<string>
required

Business-impact severity levels, ordered from most to least severe.

Available options:
critical,
high,
medium,
low
description
string
required
expected_behavior
string
required
status
string
required
created_at
string
required
attacks
ApiAttackItem · object[]
required