Take Action on Violations

Take an action on Violations

Perform an action on a list of violations. If an action can't be performed on a violation, that violation is ignored. Depending on the action, it could be processed immediately or queued.

POSThttps://api.nightfall.ai/dlp/v1/violations/actions

Body

violationUUIDs*array of string (uuid)

The UUIDs of the violations to perform the action on

itemsstring (uuid)

action*Action (enum)

ACKNOWLEDGEREDACTQUARANTINEALLOW_QUARANTINEREJECT_QUARANTINEREMOVE_INTERNAL_USERSREMOVE_EXTERNAL_USERSDOMAIN_WIDE_LINKRESTRICTED_LINKDELETEIGNORENOTIFY_SLACKNOTIFY_EMAILUNACKNOWLEDGEDISABLE_DOWNLOADCREATE_JIRA_ISSUEMARK_AS_PRIVATEDELETE_ATTACHMENTMANUAL_UNDORESOLVENOTIFY_TEAMSNOTIFY_GITHUBSOFT_DELETEHARD_DELETERESTRICT_TO_OWNER

Response

Successful response (processed immediately)

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

submittedarray of string (uuid)

violation UUIDs that were processed

itemsstring (uuid)

Request

const response = await fetch('https://api.nightfall.ai/dlp/v1/violations/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "violationUUIDs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "action": "ACKNOWLEDGE"
    }),
});
const data = await response.json();

Response

{
  "submitted": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Take an action on Violations

Perform an action on a list of violations. If an action can't be performed on a violation, that violation is ignored. Depending on the action, it could be processed immediately or queued.

POSThttps://api.nightfall.ai/dlp/v1/violations/actions

Body

violationUUIDs*array of string (uuid)

The UUIDs of the violations to perform the action on

itemsstring (uuid)

action*Action (enum)

Response

Successful response (processed immediately)

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

submittedarray of string (uuid)

violation UUIDs that were processed

itemsstring (uuid)

Request

const response = await fetch('https://api.nightfall.ai/dlp/v1/violations/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "violationUUIDs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "action": "ACKNOWLEDGE"
    }),
});
const data = await response.json();

Response

{
  "submitted": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}