Messages

Analyze a message by ID

Changed on

Analyze a message by ID with provided rules, active rules, or Feed rules in your Sublime organization. If your organization requires message-access justification, analyze results use redacted content until the API key's user sets a justification for this message with POST /v0/messages/:id/justification; body- and attachment-dependent rules may not match.

post/v0/messages/{id}/analyze

Request

  • Base URL
    https://platform.sublime.security
  • URL
    https://platform.sublime.security/v0/messages/{id}/analyze
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the message

Request body

run_active_detection_rulesboolean

Whether to analyze the message with all active detection rules in your organization

run_active_dlp_rulesboolean

Whether to analyze the message with all active DLP rules in your organization. Requires read_dlp_rules, and the message being analyzed must be outbound or internal (sent).

run_all_detection_rulesboolean

Whether to analyze with all detection rules from all Feeds, including uninstalled + inactive Feed rules, as well as any active detection rules you’ve created that are not part of a Feed.

run_all_dlp_rulesboolean

Whether to analyze with all DLP rules from all Feeds, including uninstalled + inactive Feed rules, as well as any active DLP rules you've created that are not part of a Feed. Requires read_dlp_rules, and the message being analyzed must be outbound or internal (sent).

run_all_insightsboolean

Whether to analyze with all insights

Response

OK

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property