Article

    DLP APIs - Firewall for AI Platform | Developer APIs | Nightfall Documentation

    2 min read
    Last updated 1 month ago

    DLP APIs - Firewall for AI Platform | Developer APIs

    POST /v3/scan HTTP/1.1
    Host: api.nightfall.ai
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*
    Content-Length: 1595
    
    {
      "policyUUIDs": [
        "text"
      ],
      "policy": {
        "detectionRuleUUIDs": [
          "text"
        ],
        "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"
              }
            ]
          }
        ],
        "contextBytes": 1,
        "defaultRedactionConfig": {
          "maskConfig": {
            "maskingChar": "text",
            "charsToIgnore": [
              "text"
            ],
            "numCharsToLeaveUnmasked": 1,
            "maskLeftToRight": true
          },
          "infoTypeSubstitutionConfig": {},
          "substitutionConfig": {
            "substitutionPhrase": "text"
          },
          "cryptoConfig": {
            "publicKey": "text"
          },
          "removeFinding": true
        },
        "alertConfig": {
          "slack": {
            "target": "text"
          },
          "email": {
            "address": "text"
          },
          "url": {
            "address": "text"
          },
          "siem": {
            "address": "text",
            "sensitiveHeaders": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "plainTextHeaders": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      },
      "payload": [
        "text"
      ]
    }