File scanned RabbitMQ notifications

Overview

File Scanned RabbitMQ notifications allow you to receive real-time alerts whenever a file has been scanned by MetaDefender Storage Security. This feature is useful if you need to:

  • Enable cross-MDSS instance scanning where one MDSS instance publishes scan results and another automatically rescans the file

Setup

  1. Go to Settings > Notifications in the MetaDefender Storage Security console.
  2. Select Send a RabbitMQ notification when a file is scanned under the RabbitMQ Notifications section
  3. Choose whether you want to receive notifications for all scanned files or only blocked files.
  4. Enter the RabbitMQ URL (your endpoint).
  5. (Optional) Add any custom headers.
  6. Save the configuration.

Configuration Details

  • RabbitMQ URL – The URL of the receiving system (ex: amqp://username:passowrd@localhost:27049).

  • Headers – Optional key-value pairs (e.g., StorageClientId: string; ScanId: string).

    • StorageClientId - destination storage client Id
    • ScanId - destination scanId
  • Notification scope – Choose between:

    • All scanned files → You will receive a notification for every file scanned.
    • Blocked only → You will only receive notifications when a file is marked as blocked in MetaDefender Storage Security (see File Definition)

RabbitMQ Payload

When triggered, the RabbitMQ sends a JSON request body to your configured endpoint.

RabbitMq payload
MetadataToBuild
Copy

Field Reference

FieldTypeExample ValueDescription
ScanIdstring (UUID)01985f77-2b01-764a-bc6e-6cc3e38f3761Unique identifier of the destination scan.
StorageClientIdstring01985f77-2b01-764a-bc6e-6cc3e38f3761Unique identifier of the destination storage client.
IsPublicWebhookboolfalseUsed only for webhook
MetadataWebHookMetadataRtp""Empty for RabbitMQ notification
MetadataToBuildWebHookMetadataRtpSerialized FileScannedNotificationDetailsPopulated with FileScannedNotificationDetails

Delivery Behavior

  • Cross-MDSS Instance Scanning: When MDSS Instance A completes a scan and publishes to RabbitMQ, Instance B consumes the notification and automatically triggers an Event-Based RTP scan for the same file.
  • Delivery is best-effort → if the destination is invalid, the request is logged in the Audit page, but no retries are performed.

Security Considerations

  • The RabbitMQ URL is stored encrypted

Troubleshooting

  • No RabbitMQ message received → Verify the endpoint URL and headers you configured.
  • Audit shows delivery failed → Endpoint is invalid. Fix and test again.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard