Fetch Annotations

PreviousTake Action on Violations NextAnnotate Findings

Last updated 6 months ago

Was this helpful?

Fetch annotation

Fetch an annotation by ID

GEThttps://api.nightfall.ai/dlp/v1/annotations/{annotationId}

Authorization

Path parameters

annotationId*string (uuid)

The UUID of the annotation to fetch

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/annotations/{annotationId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

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