Sanitize API Reference
curl -sSLX POST 'https://sanitize.aws.us.pangea.cloud/v1/sanitize' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: multipart/form-data'Response
Sanitize V1
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.
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.
- minLength: 36
object
string
(default: "crowdstrike")Provider to use for File Scan
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
If redact is enabled, avoids redacting the file and instead returns the PII analysis engine results. Only works if redact is enabled
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
array<object>
The scoring result of a set of rules
string
The entity name
number
The certainty score that the entity matches this specific snippet
string
The text snippet that matched
integer
The starting index of a snippet
integer
The ending index of a snippet
boolean
Indicates if this rule was used to anonymize a text snippet
string, null
If this result relates to a specific structured text field, the key pointing to this text will be provided
object, null
Context information If context was applied to score
object, null
Context information If negative context was applied to score
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.