Annotate Findings

PreviousFetch Annotations NextRemove Annotation Findings

Last updated 6 months ago

Was this helpful?

Annotate finding

Annotate a finding

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

Authorization

Path parameters

findingId*string (uuid)

The UUID of the finding to annotate

Body

type*enum

The annotation type

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

Successful response

Headers

Body

idstring (uuid)

The annotation id

typeenum

The annotation type

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

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

Response

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