Scan Uploaded File

Scan Uploaded File

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.

post

/v3/upload/{fileId}/scan

Authorizations

Path parameters

fileIdstring · uuidrequired

a file ID returned from a previous file creation request

Body

policyUUIDstring · uuid

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

policyobject

requestMetadatastring

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

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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": {
      "webhookURL": "text",
      "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"
  }'

200

400

401

404

409

422

429

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Success