Skip to main content

Sanitize API Reference

Beta

Base URL

sanitize.<csp>.<region>.pangea.cloud

post/v1beta/sanitize
curl -sSLX POST 'https://sanitize.aws.us.pangea.cloud/v1beta/sanitize' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: multipart/form-data'

Response

Sanitize V1 Beta

POST
https://sanitize.aws.us.pangea.cloud/v1beta/sanitize

Apply file sanitization actions according to specified rules.

 

Refer to the Transfer Methods document for details on using transfer_method and share_output parameters for providing the input and receiving the sanitized output.

 

required parameters

object
string

The transfer method used to upload the file data.

object
string (uri)

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

string

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

object
string
(default: "crowdstrike")

Provider to use for File Scan

string
(default: "apryse")

Provider to use for CDR

object
boolean
(default: true)

Perform URL Intel lookup

string
(default: "crowdstrike")

Provider to use for URL Intel

boolean
(default: true)

Perform Domain Intel lookup

string
(default: "crowdstrike")

Provider to use for Domain Intel lookup

boolean
(default: true)

Defang external links.

integer
(default: 30)

Defang risk threshold.

boolean
(default: false)

Redact sensitive content.

boolean
(default: true)

Remove file attachments (PDF only).

boolean
(default: true)

Remove interactive content (PDF only).

object
boolean
(default: false)

Store Sanitized files to Pangea Secure Share.

If not enabled, a presigned URL will be returned in 'result.dest_url'.

string
(default: "")

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

number

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

string

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

string

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

string

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

object

Pangea standard response schema

object
string (uri)

A URL where the Sanitized file can be downloaded.

string

Pangea Secure Share ID of the Sanitized file.

object
object
integer

Number of external links found.

integer

Number of external domains found.

integer

Number of items defanged per provided rules and detections.

string

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

string

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

object
integer

Number of items redacted

object
integer
boolean

If the file scanned was malicious

object
integer

Number of file attachments removed

integer

Number of interactive content items removed

object

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

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"
string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"
string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"
string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"
string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.

Was this article helpful?

Contact us