Sanitize | Node.js SDK

Sanitize

constructor(token: string, config: PangeaConfig): SanitizeService

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

required parameters

token

string

Pangea API token.

configPangeaConfig

Configuration.

Response Object

SanitizeService

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

Sanitize via presigned URL

requestUploadURL(request: SanitizeRequest): Promise<PangeaResponse<SanitizeResult>>

Apply file sanitization actions according to specified rules via a presigned URL.

required parameters

requestSanitizeRequest

Request parameters.

Response Object

SanitizeResult

Promise<PangeaResponse<SanitizeResult>>

const request: Sanitize.SanitizeRequest = {
  transfer_method: TransferMethod.PUT_URL,
  uploaded_file_name: "uploaded_file",
};
const presignedUrl = await sanitize.requestUploadURL(request);

// Upload file to `presignedUrl.accepted_result.put_url`.

// Poll for Sanitize's result.
const response = await sanitize.pollResult<Sanitize.SanitizeResult>(presignedUrl.request_id);

Sanitize

sanitize(request: SanitizeRequest, fileData: FileData, options: Options): Promise<PangeaResponse<SanitizeResult>>

Apply file sanitization actions according to specified rules.

required parameters

requestSanitizeRequest

Request parameters.

fileDataFileData

Optional file data for when the "source-url" transfer method is used.

optionsOptions

Additional options.

Response Object

SanitizeResult

Promise<PangeaResponse<SanitizeResult>>

import { readFile } from "node:fs/promises";

const request: Sanitize.SanitizeRequest = {
  transfer_method: TransferMethod.POST_URL,
  uploaded_file_name: "uploaded_file",
};
const response = await sanitize.sanitize(
  request,
  { file: await readFile("/path/to/file.pdf"), name: "filename" }
);

Interface CDR

CDR

optional parameters

file_attachments_removed

number

Number of file attachments removed.

interactive_contents_removed

number

Number of interactive content items removed.

Interface DefangData

DefangData

optional parameters

defanged_count

number

Number of items defanged per provided rules and detections.

domain_intel_summary

string

Processed N Domains: X are malicious, Y are suspicious, Z are unknown.

external_domains_count

number

Number of external domains found.

external_urls_count

number

Number of external links found.

url_intel_summary

string

Processed N URLs: X are malicious, Y are suspicious, Z are unknown.

Interface Options

Options

optional parameters

pollResultSync

boolean

Interface RedactData

RedactData

optional parameters

recognizer_resultsArray<RedactRecognizerResult>

The scoring result of a set of rules.

redaction_count

number

Number of items redacted.

summary_countsDictionary

Summary counts.

Interface RedactRecognizerResult

RedactRecognizerResult

required parameters

end

number

The ending index of a snippet.

field_type

string

The entity name.

redacted

boolean

Indicates if this rule was used to anonymize a text snippet.

score

number

The certainty score that the entity matches this specific snippet.

start

number

The starting index of a snippet.

text

string

The text snippet that matched.

Interface SanitizeContent

SanitizeContent

optional parameters

defang

boolean

Defang external links.

defang_threshold

number

Defang risk threshold.

domain_intel

boolean

Perform Domain Intel lookup.

domain_intel_provider

string

Provider to use for Domain Intel lookup.

redact

boolean

Redact sensitive content.

redact_detect_only

boolean

If redact is enabled, avoids redacting the file and instead returns the PII analysis engine results. Only works if redact is enabled.

remove_attachments

boolean

Remove file attachments (PDF only).

remove_interactive

boolean

Remove interactive content (PDF only).

url_intel

boolean

Perform URL Intel lookup.

url_intel_provider

string

Provider to use for URL Intel.

Interface SanitizeData

SanitizeData

optional parameters

cdrCDR

Content Disarm and Reconstruct.

defangDefangData

Defang.

malicious_file

boolean

If the file scanned was malicious.

redactRedactData

Redact.

Interface SanitizeFile

SanitizeFile

optional parameters

scan_provider

string

Provider to use for File Scan.

Interface SanitizeRequest

SanitizeRequest

required parameters

transfer_methodTransferMethod

The transfer method used to upload the file data.

optional parameters

contentSanitizeContent

Content.

crc32c

string

The CRC32C hash of the file data, which will be verified by the server if provided.

fileSanitizeFile

File.

sha256

string

The hexadecimal-encoded SHA256 hash of the file data, which will be verified by the server if provided.

share_id

string

A Pangea Secure Share ID where the file to be Sanitized is stored.

share_outputSanitizeShareOutput

Share output.

size

number

The size (in bytes) of the file. If the upload doesn't match, the call will fail.

source_url

string

A URL where the file to be Sanitized can be downloaded.

uploaded_file_name

string

Name of the user-uploaded file, required for transfer-method 'put-url' and 'post-url'.

Interface SanitizeResult

SanitizeResult

required parameters

dataSanitizeData

Sanitize data.

parametersDictionary

The parameters, which were passed in the request, echoed back.

optional parameters

dest_share_id

string

Pangea Secure Share ID of the Sanitized file.

dest_url

string

A URL where the Sanitized file can be downloaded.

Interface SanitizeShareOutput

SanitizeShareOutput

optional parameters

enabled

boolean

Store Sanitized files to Pangea Secure Share. If not enabled, a presigned URL will be returned in 'result.dest_url'.

output_folder

string

Store Sanitized files to this Secure Share folder (will be auto-created if not exists).