Print Download PDF Send Feedback

Previous

Next

extraction Response Format

Field

Type

Value

tex_product

Boolean

true | false

True if the queried file is already a Sandblast-safe copy.

status

 

Status of Threat Extraction on the requested file.

> code

Integer

Status code

> label

String

Readable code label

If value is FOUND, the other fields are given.

> message

String

Readable status message

extract_result

String

CP_EXTRACT_RESULT_UNKNOWN (Default - returned if the POD did not receive an answer from the Threat Extraction engine in 60 seconds)

CP_EXTRACT_RESULT_SUCCESS
CP_EXTRACT_RESULT_FAILURE
CP_EXTRACT_RESULT_TIMEOUT
CP_EXTRACT_RESULT_UNSUPPORTED_FILE
CP_EXTRACT_RESULT_NOT_SCRUBBED
CP_EXTRACT_RESULT_INTERNAL_ERROR
CP_EXTRACT_RESULT_DISK_LIMIT_REACHED
CP_EXTRACT_RESULT_ENCRYPTED_FILE
CP_EXTRACT_RESULT_DOCSEC_FILE
CP_EXTRACT_RESULT_OUT_OF_MEMORY

extracted_file_download_id

String

The download id of the extracted file, for download request.

Only sent when extract_result = CP_EXTRACT_RESULT_SUCCESS

extraction_data

JSON object

Data of the extracted file.

extraction_data

Field

Type

Value

input_extension

String

Uploaded filename-extension as sent by the client

input_real_extension

String

Extension as resolved by Threat Extraction

orig_file_url

String

Url to original filename - empty in cloud response

output_file_name

String

The name of the output file. The file extension may be modified after extraction, for example: docm > docx

risk

Float

Represents the risk of the part that was extracted from the document

scrub_method

String

Convert to PDF | Clean Document

protection_type

String

Protection done for scrub_method:

Conversion to PDF | Content Removal

protection_name

String

"Potential malicious content extracted"

scrub_result

Float

Code result from Threat Extraction

message

String

Status message for scrub_result

scrub_activity

String

Readable result from Threat Extraction

scrub_time

Float

Threat Extraction process time

scrubbed_content

String

Content that was removed