All pages
Powered by GitBook
1 of 7

DLP APIs - Firewall for AI Platform

Firewall for AI DLP APIs enables developers to write custom code to sanitize data anywhere–RAG data sets, analytics data stores, data pipelines, and unsupported SaaS applications.

Scan Plain Text

Initiate File Upload

Upload File Chunk

Upload File Chunk

patch

Upload all bytes contained in the request body to the file identified by the ID in the path parameter.

Authorizations
Path parameters
fileIdstring · uuidrequired

a file ID returned from a previous file creation request

Header parameters
X-Upload-Offsetintegerrequired

The numeric offset at which the bytes contained in the body should be written. This offset must be a multiple of the chunk size returned when the file upload was created.

Body
anyoptional

The payload bytes to upload; the size of the request body must exactly match the chunkSize that was returned when the file upload was created.

Responses
curl -L \
  --request PATCH \
  --url 'https://api.nightfall.ai/v3/upload/{fileId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'X-Upload-Offset: 1' \
  --header 'Content-Type: application/octet-stream'
No Content

Success

Loading...

Scan Uploaded File

Scan Uploaded File

post

Triggers a scan of the file identified by the provided fileID. As the underlying file might be arbitrarily large, this scan is conducted asynchronously. Results from the scan are delivered to the webhook URL provided in the request payload.

Authorizations
Path parameters
fileIdstring · uuidrequired

a file ID returned from a previous file creation request

Body
policyUUIDstring · uuidoptional

the UUID of the Detection Policy to be used with this scan. Exactly one of this field or "policy" should be provided.

policyobjectoptional

requestMetadatastringoptional

A string containing arbitrary metadata. Callers may opt to use this to help identify their input file upon receiving a webhook response. Maximum length 10 KB.

Responses
curl -L \
  --request POST \
  --url 'https://api.nightfall.ai/v3/upload/{fileId}/scan' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "policyUUID": "123e4567-e89b-12d3-a456-426614174000",
    "policy": {
      "detectionRuleUUIDs": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "detectionRules": [
        {
          "name": "text",
          "logicalOp": "ANY",
          "detectors": [
            {
              "minNumFindings": 1,
              "minConfidence": "VERY_UNLIKELY",
              "detectorUUID": "text",
              "displayName": "text",
              "detectorType": "NIGHTFALL_DETECTOR",
              "nightfallDetector": "AMERICAN_BANKERS_CUSIP_ID",
              "regex": {
                "pattern": "text",
                "isCaseSensitive": true
              },
              "wordList": {
                "values": [
                  "text"
                ],
                "isCaseSensitive": true
              },
              "contextRules": [
                {
                  "regex": {
                    "pattern": "text",
                    "isCaseSensitive": true
                  },
                  "proximity": {
                    "windowBefore": 1,
                    "windowAfter": 1
                  },
                  "confidenceAdjustment": {
                    "fixedConfidence": "VERY_UNLIKELY"
                  }
                }
              ],
              "exclusionRules": [
                {
                  "matchType": "PARTIAL",
                  "exclusionType": "REGEX",
                  "regex": {
                    "pattern": "text",
                    "isCaseSensitive": true
                  },
                  "wordList": {
                    "values": [
                      "text"
                    ],
                    "isCaseSensitive": true
                  }
                }
              ],
              "redactionConfig": {
                "maskConfig": {
                  "maskingChar": "text",
                  "charsToIgnore": [
                    "text"
                  ],
                  "numCharsToLeaveUnmasked": 1,
                  "maskLeftToRight": true
                },
                "infoTypeSubstitutionConfig": {},
                "substitutionConfig": {
                  "substitutionPhrase": "text"
                },
                "cryptoConfig": {
                  "publicKey": "text"
                },
                "removeFinding": true
              },
              "scope": "Content"
            }
          ]
        }
      ],
      "alertConfig": {
        "slack": {
          "target": "text"
        },
        "email": {
          "address": "text"
        },
        "url": {
          "address": "text"
        },
        "siem": {
          "address": "text",
          "sensitiveHeaders": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "plainTextHeaders": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "defaultRedactionConfig": {
        "maskConfig": {
          "maskingChar": "text",
          "charsToIgnore": [
            "text"
          ],
          "numCharsToLeaveUnmasked": 1,
          "maskLeftToRight": true
        },
        "infoTypeSubstitutionConfig": {},
        "substitutionConfig": {
          "substitutionPhrase": "text"
        },
        "cryptoConfig": {
          "publicKey": "text"
        },
        "removeFinding": true
      },
      "enableFileRedaction": true
    },
    "requestMetadata": "text"
  }'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Success

Loading...