Sanitize API Reference

Base URL

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

• Sanitize Documentation
• OpenAPI Specification

post/v1/sanitize

cURL

Code Snippet Language

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

Response

Raw Output

200

Code Snippet Language

---

Sanitize V1

POST

https://sanitize.aws.us.pangea.cloud/v1/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.

 

Content Type

multipart/form-data

Content Type

required parameters

request

object

transfer_method

string

The transfer method used to upload the file data.

transfer_method

​

transfer_method

upload

​

optional parameters

request

object

source_url

string (uri)

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

source_url

source_url

share_id

string

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

• minLength: 36

​

file

object

scan_provider

string

(default: "crowdstrike")

Provider to use for File Scan

scan_provider

​

scan_provider

content

object

url_intel

boolean

(default: true)

Perform URL Intel lookup

url_intel

​

url_intel

url_intel_provider

string

(default: "crowdstrike")

Provider to use for URL Intel

url_intel_provider

​

url_intel_provider

domain_intel

boolean

(default: true)

Perform Domain Intel lookup

domain_intel

​

domain_intel

domain_intel_provider

string

(default: "crowdstrike")

Provider to use for Domain Intel lookup

domain_intel_provider

​

domain_intel_provider

defang

boolean

(default: true)

Defang external links.

defang

​

defang

defang_threshold

integer

(default: 30)

Defang risk threshold.

defang_threshold

defang_threshold

redact

boolean

(default: false)

Redact sensitive content.

redact

​

redact

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

redact_detect_only

​

redact_detect_only

remove_attachments

boolean

(default: true)

Remove file attachments (PDF only).

remove_attachments

​

remove_attachments

remove_interactive

boolean

(default: true)

Remove interactive content (PDF only).

remove_interactive

​

remove_interactive

share_output

object

enabled

boolean

(default: false)

Store Sanitized files to Pangea Secure Share.

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

enabled

​

enabled

output_folder

string

(default: "")

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

output_folder

output_folder

size

number

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

size

size

crc32c

string

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

crc32c

crc32c

sha256

string

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

sha256

sha256

uploaded_file_name

string

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

uploaded_file_name

uploaded_file_name

Response Fields

Response Schema

object

Pangea standard response schema

result

object

dest_url

string (uri)

A URL where the Sanitized file can be downloaded.

dest_share_id

string

Pangea Secure Share ID of the Sanitized file.

data

object

defang

object

external_urls_count

integer

Number of external links found.

external_domains_count

integer

Number of external domains found.

defanged_count

integer

Number of items defanged per provided rules and detections.

url_intel_summary

string

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

domain_intel_summary

string

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

redact

object

redaction_count

integer

Number of items redacted

summary_counts

object

Pattern Property: .*

integer

recognizer_results

array<object>

The scoring result of a set of rules

field_type

string

The entity name

score

number

The certainty score that the entity matches this specific snippet

text

string

The text snippet that matched

start

integer

The starting index of a snippet

end

integer

The ending index of a snippet

redacted

boolean

Indicates if this rule was used to anonymize a text snippet

data_key

string, null

If this result relates to a specific structured text field, the key pointing to this text will be provided

context_results

object, null

Context information If context was applied to score

negative_context_results

object, null

Context information If negative context was applied to score

malicious_file

boolean

If the file scanned was malicious

cdr

object

file_attachments_removed

integer

Number of file attachments removed

interactive_contents_removed

integer

Number of interactive content items removed

parameters

object

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

request_id

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"

request_time

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"

response_time

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"

status

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"

summary

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