Fetch Annotions

Fetch annotation

Fetch an annotation by ID

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

Path parameters

annotationId*string (uuid)

The UUID of the annotation to fetch

Response

Successful response

Headers

X-Rate-Limit-Remaininginteger

How many remaining requests you can make within the next second before being throttled

X-Quota-Remaininginteger

How many remaining requests you can make within the next quota period

X-Quota-Period-Endstring (date-time)

When the current quota period expires

Body

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

Response

Fetch annotation

Fetch an annotation by ID

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

Path parameters

annotationId*string (uuid)

The UUID of the annotation to fetch

Response

Successful response

Headers

X-Rate-Limit-Remaininginteger

How many remaining requests you can make within the next second before being throttled

X-Quota-Remaininginteger

How many remaining requests you can make within the next quota period

X-Quota-Period-Endstring (date-time)

When the current quota period expires

Body

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

Response

const response = await fetch('https://api.nightfall.ai/dlp/v1/annotations/{annotationId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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