Annotate Findings

Annotate finding

Annotate a finding

POSThttps://api.nightfall.ai/dlp/v1/findings/{findingId}/annotate

Path parameters

findingId*string (uuid)

The UUID of the finding to annotate

Body

application/json

type*AnnotationType (enum)

DETECTOR_FALSE_POSITIVECOMPANY_IGNORED_FALSE_POSITIVEDETECTOR_TRUE_POSITIVE

commentstring

The comment to add to the annotation

autoApplyboolean

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

Response

200400401409429500

Successful response

Headers

Body

application/json

idstring (uuid)

The annotation id

typeAnnotationType (enum)

DETECTOR_FALSE_POSITIVECOMPANY_IGNORED_FALSE_POSITIVEDETECTOR_TRUE_POSITIVE

commentstring

The annotation comment

autoApplyboolean

Whether the annotation applies to all findings of this sensitive data

Request

JavaScriptCurlPython

const response = await fetch('https://api.nightfall.ai/dlp/v1/findings/{findingId}/annotate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "DETECTOR_FALSE_POSITIVE"
    }),
});
const data = await response.json();

Response

200400401409429500

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