Sign in

v1

latestOpenAPI 3.1.02026-07-26363186558.0 KB
DTM Alerts

Asynchronously bulk update alerts using query params to target the alerts

post/alerts/bulk/apply

Query parameters

bucketsboolean

If true, then alert buckets are updated where applicable.

monitor_idstring
Example:c4fcpm2bqsiatib6i4h0

Only return alerts for the given monitor ID. This parameter can be specified multiple times to filter on more than one monitor ID.

has_analysisboolean

If true, then only alerts that have analysis are returned. An alert has anlysis if it has either analysis text or analysis file attachments.

sincestring date-time

When listing alerts by date range, since defines the starting date in RFC3339 format

untilstring date-time

When listing alerts by date range, until defines the ending date in RFC3339 format

status'new' | 'read' | 'escalated' | 'in_progress' | 'closed' | 'no_action_required' | 'duplicate' | 'not_relevant' | 'tracked_external'

Filter alerts by their status. This parameter can be specified multiple times.

alert_type'Compromised Credentials' | 'Domain Discovery' | 'Forum Post' | 'Message' | 'Paste' | 'Shop Listing' | 'Tweet' | 'Web Content'

Filter alerts by alert type. This parameter can be specified multiple times.

searchstring

Search alert and triggering doc contents based on a simple Lucene query string including 1 or more text values separated by AND or OR.

match_valuestring

If specified, then only alerts that have the given match value are returned. This parameter can be repeated multiple times.

tagsstring

Filter alerts by tag(s). This parameter can be used more than once to filter on multiple tags.

search_encoding'base64'

When using the search parameter, its value can be base64 encoded in which case search_encoding indicates the value encoding type.

severity'high' | 'medium' | 'low'

Return alerts that have the given severity. This parameter can be repeated multiple times.

mscore_gteinteger

Filter alerts with mscores greater than or equal to the given value.

Headers

x-apikeystring required

Your API key

Content-Type'application/json' required

The content type of the body.

Request body

add_tagsstring[]

Tags to add on any alerts updated. Duplicate tags will not be created on any alert.

exlcude_idsstring[]

If provided, an array of alert IDs that should be explictly skipped during the update operation.

remove_tagsstring[]

Tags to remove on any alerts updated.

status'new' | 'read' | 'escalated' | 'in_progress' | 'closed' | 'no_action_required' | 'duplicate' | 'not_relevant' | 'tracked_external'

The status to apply to the alerts.

Response

Accepted and will be processed in the background.