Reference
Start typing to search…

List alerts

get
https://www.virustotal.com/api/v3/dtm/alerts

Get alerts for the current organization. This API uses the next link header to provide the URI of the next page of results. When fetching subsequent pages, only use the link header URI.

Query Params
string
enum
Defaults to created_at

The alert field name to sort the response alerts by.

Allowed:
string
enum
Defaults to desc

The order used to sort the response alerts field by.

Allowed:
integer
0 to 25
Defaults to 10

The number of alerts to return in each page. Max value of 25.

string

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

boolean
Defaults to true

If false, doc, labels, and topics are not returned in the response body.

boolean
Defaults to false

If true, then any links in the alert doc are sanitized and replaced.

boolean
Defaults to false

If true, then the monitor's name that created the alert is returned in the alert response body.

boolean

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

boolean
Defaults to false

If true, then alert buckets are returned for aggregated alerts. If false, then bucket format is not returned, but instead all child aggregated alerts are.

date-time

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

date-time

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

string

Only used when fetching subsequent pages during pagination and will contain a unique page ID. No other query parameters can be used with page

integer

Truncates document fields to the given length using unicode ellipsis (\x2026) to indicate truncation

string
enum

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

string
enum

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

string

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

string

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

string

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

string
enum

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

Allowed:
string
enum

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

Allowed:
string

If true, any HTML content in the alert is sanitized to ensure it does not potentially contain malicious tags. If not used, be careful when rendering/using the alert/doc content. This param can also be specified as a json path in the alert document to sanitize and may be repeated in this case.

integer
0 to 100

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

Headers
string
required

Your API key

Responses

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago