Analyze a message by ID

post

{scheme}://{server}/v0/messages/{id}/analyze

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the message

Body Params

queries

array of objects

Queries to analyze

queries

rules

array of objects

Rules to analyze

rules

run_active_detection_rules

boolean

Defaults to false

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

run_active_dlp_rules

boolean

Defaults to false

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_rules

boolean

Defaults to false

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_rules

boolean

Defaults to false

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_insights

boolean

Defaults to false

Whether to analyze with all insights

Response

200OK