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.

POSThttps://api.nightfall.ai/v3/upload/{fileId}/scan

Authorization

BearerAuth

Path parameters

fileId*string (uuid)

a file ID returned from a previous file creation request

Body

application/json

policyUUIDstring (uuid)

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

policyPolicyV3 (object)

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.

Response

200400401404409422429500

Success

Headers

Body

application/json

idstring (uuid)

a UUID to uniquely identify a particular file upload

messagestring

message indicating that file scanning has been initiated

Request

JavaScriptCurlPython

const response = await fetch('https://api.nightfall.ai/v3/upload/{fileId}/scan', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401404409422429500

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