Skip to main content

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

string

Pangea API token.

Configuration.

Response Object

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

post(endpoint: string, data: object, options: PostOptions): Promise<PangeaResponse<R>>

POST request.

required parameters

string

Endpoint path.

object

Request body.

Additional options.

Response Object

Promise<PangeaResponse<R>>

Sanitize via presigned URL (Beta)

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

Apply file sanitization actions according to specified rules via a presigned URL. How to install a Beta release.

required parameters

SanitizeRequest

Request parameters.

Response Object

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 (Beta)

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

Apply file sanitization actions according to specified rules. How to install a Beta release.

required parameters

SanitizeRequest

Request parameters.

FileData

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

Options

Additional options.

Response Object

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

number
number

Interface DefangData

DefangData

optional parameters

number
string
number
number
string

Interface Options

Options

optional parameters

boolean

Interface RedactData

RedactData

optional parameters

number
Dictionary

Interface SanitizeContent

SanitizeContent

optional parameters

boolean
number
boolean
string
boolean
boolean
boolean
boolean
string

Interface SanitizeData

SanitizeData

optional parameters

CDR
boolean

Interface SanitizeFile

SanitizeFile

optional parameters

string
string

Interface SanitizeRequest

SanitizeRequest

required parameters

TransferMethod

optional parameters

string
string
string
number
string
string

Interface SanitizeResult

SanitizeResult

required parameters

SanitizeData
Dictionary

optional parameters

string
string

Interface SanitizeShareOutput

SanitizeShareOutput

optional parameters

boolean
string