Skip to main content

File Scan | Node.js SDK

File Scan

constructor(token: PangeaToken, config: PangeaConfig): FileScanService

Creates a new FileScanService with the given Pangea API token and configuration.

PangeaToken

Pangea API token.

Configuration.

FileScanService
const config = new PangeaConfig({ domain: "pangea_domain" });
const client = new FileScanService("pangea_token", config);

Scan

fileScan(request: ScanRequest, file: string | FileData, options: Options): Promise<PangeaResponse<ScanResult>>

Scan a file for malicious content.

ScanRequest
string | FileData
Options

Promise<PangeaResponse<ScanResult>>
const request = { verbose: true, raw: true, provider: "crowdstrike" };
const response = await client.fileScan(request, "./path/to/file.pdf");

Interface Options

Options

boolean

Interface ScanFileParams

ScanFileParams

string
string
number

Interface ScanFullRequest

ScanFullRequest

string
string
number

string
boolean
string
TransferMethod
boolean

Interface ScanRequest

ScanRequest

string
boolean
string
TransferMethod
boolean

Interface ScanResult

ScanResult

Dictionary
Dictionary