Annotate Findings

PreviousFetch Annotations NextRemove Annotation Findings

Last updated 7 months ago

Was this helpful?

Annotate finding

Annotate a finding

post

/findings/{findingId}/annotate

Authorizations

Path parameters

findingIdstring · uuidrequired

The UUID of the finding to annotate

Body

typestring · enumrequired

The annotation type

Options: DETECTOR_FALSE_POSITIVE, COMPANY_IGNORED_FALSE_POSITIVE, DETECTOR_TRUE_POSITIVE

commentstring

The comment to add to the annotation

autoApplyboolean · default: true

Whether the annotation applies to all findings of this sensitive data (defaults to true)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.nightfall.ai/dlp/v1/findings/{findingId}/annotate' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"type":"DETECTOR_FALSE_POSITIVE","autoApply":true}'

200

400

401

409

429

500

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "DETECTOR_FALSE_POSITIVE",
  "comment": "text",
  "autoApply": true
}

Successful response