Skip to main content
PATCH
Resolve or reopen a signal

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

signal_id
string
required

Body

application/json

Body for resolving or reopening a signal.

Only resolved and open are settable here. A dismissed signal never reopens on a new finding, so dismissing stays a decision a person makes in the web app. Resolving needs a reason; the reason other also needs a note. The write service is the single validator of those rules.

project_id
string
required
status
enum<string>
required
Available options:
resolved,
open
expected_status
enum<string>

The status the caller last read. When the signal's current status differs, nothing is written and the answer is a 409.

Available options:
open,
resolved,
dismissed
note
string

A free-text note; required when reason is "other"

Maximum string length: 4000
reason
enum<string>

Why the signal is resolved; required when status is "resolved"

Available options:
fixed_elsewhere,
fixed_by_pr,
already_fixed_before,
other

Response

Successful Response

The signal after the write. changed is empty when it already had that status.

changed
string[]
required
signal
SignalStatusRow · object
required

A signal as the status write returns it.

updated
boolean
required