How do I Monitor Deep CDR Success or Failure via API Response Keys?

Overview

To monitor the success or failure of the Deep CDR (Content Disarm and Reconstruction) process via API integration, you can use the actions_ran and actions_failed response keys.

These keys provide detailed status feedback for each file processed and can be used to improve monitoring, alerting, and reporting on sanitization outcomes.

Response Keys for Monitoring

🔹 actions_failed

  • Type: String
  • Description: Contains a list of failed actions, separated by "|", or is an empty string if no actions failed.

Possible Values:

ValueMeaning
Sanitization FailedThe sanitization process failed. This may occur if Deep CDR is inactive in the workflow but is disabled in Inventory, or if the engine encounters an internal failure while processing the file.
Sanitization Timed OutThe process exceeded the standard timeout.
Sanitization Global Timeout ExceededThe scan exceeded the global timeout defined in: Workflow > <Workflow Name> > Timeouts > Enable global timeout.
Sanitization CanceledThe process was manually canceled by the user or client.

🔹 actions_ran

  • Type: String
  • Description: Contains a list of successfully executed actions, separated by "|", or is an empty string if no actions ran.

Possible Values:

ValueMeaning
SanitizedThe file was successfully sanitized. Applies to both Deep CDR and ARC Compression Sanitization.
Sanitized PartiallyArchive was sanitized partially. It occurs when some nested files are skipped or blocked due to unsupported file types or other conditions.
Sanitization SkippedThe file was intentionally skipped from sanitization, e.g., due to being digitally signed.

We recommend that integrators use both actions_ran and actions_failed fields in their API handling logic to:

  • Detect whether the sanitization process succeeded or failed.
  • Determine the exact reason for failure (if any).
  • Enable logging and alerting for critical failure cases.
  • Support more robust retry or fallback mechanisms.

If further guidance is needed for API integration, workflow configuration, or conducting a PoC, please contact Support for assistance.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
What dependencies does MetaDefender’s Deep CDR for Linux have?
On This Page
How do I Monitor Deep CDR Success or Failure via API Response Keys?OverviewResponse Keys for Monitoring🔹 actions_failedPossible Values:🔹 actions_ranPossible Values:Recommended Use