Skip to main content
PATCH
/
v1
/
findings
/
{id}
Update a finding (status transition rules apply)
curl --request PATCH \
  --url http://localhost:3333/v1/findings/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "open",
  "type": "soc2",
  "severity": "low",
  "content": "<string>",
  "revisionNote": {}
}
'

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Finding ID

Body

application/json
​
status
enum<string>

Finding status

Available options:
open,
ready_for_review,
needs_revision,
closed
​
type
enum<string>

Finding type

Available options:
soc2,
iso27001
​
severity
enum<string>

Severity

Available options:
low,
medium,
high,
critical
​
content
string

Finding content/message

Maximum string length: 5000
​
revisionNote
object

Auditor note when requesting revision

Response

200 - undefined