Fetch Violation Findings

PreviousSearch Violations NextTake Action on Violations

Last updated 7 months ago

Was this helpful?

Fetch violation findings

Get findings for a specific violation

get

/violations/{violationId}/findings

Authorizations

Path parameters

violationIdstring · uuidrequired

The UUID of the violation

Query parameters

pageTokenstring

Cursor for getting the next page of results

limitinteger · int32 · max: 1000 · default: 1000

Number of findings to fetch in one page (max 1000)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.nightfall.ai/dlp/v1/violations/{violationId}/findings' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

404

429

500

{
  "nextPageToken": "text",
  "findings": [
    {
      "id": "text",
      "detectorUUID": "text",
      "subDetectorUUID": "text",
      "confidence": "text",
      "redactedSensitiveText": "text",
      "redactedContext": {
        "beforeContext": "text",
        "afterContext": "text"
      },
      "redactedLocation": {
        "byteRange": {
          "start": 1,
          "end": 1
        },
        "lineRange": {
          "start": 1,
          "end": 1
        }
      },
      "metadata": {
        "apiKeyMetaData": {
          "status": "UNVERIFIED",
          "kind": "UNSPECIFIED",
          "description": "text"
        }
      },
      "subLocation": "text",
      "annotationUUID": "text"
    }
  ]
}

Successful response