List all Active Alert

ThousandEyes API v6 has been deprecated as of May 27, 2024. We strongly recommend that you migrate to ThousandEyes API v7 to ensure continued support and access to new features. For more information, see the deprecation notice.

GET /v6/alerts

Returns a list of all active alerts either at present, or based on the time range specified.

• When you specify a time range, the response includes both active and cleared alerts that occurred within that specified time frame. Cleared alerts may appear in the response if they were triggered during the given range but cleared afterward.
• If no time range is provided in the request, the response includes only the currently active alerts.

Parameters

• format=json|xml optional (querystring), specifies the format of output requested. See Output Formats for more information
• window=[0-9]+[smhdw]? specifies a window of time for the result set. See Time Ranges for more information.
• from=YYYY-mm-ddTHH:MM:SS&to=YYYY-mm-ddTHH:MM:SS specifies an explicit start (and optionally, end) for your range of data. See Time Ranges for more information.
• aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

• no request body

Example

Copy$ curl https://api.thousandeyes.com/v6/alerts.json \
  -u {email}:{authToken}

Response

Sends back an array of active alerts, either at present, or based on the time range specified, indicating testId and testName, alert rule. If no alerts are active during the time range specified, an empty response will be returned.

Agent and Monitor objects (see above) reflect the following content:

Header

CopyHTTP/1.1 200 OK
Server: nginx
Date: Mon, 09 May 2016 16:04:24 GMT
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-store
X-Organization-Rate-Limit-Limit: 240
X-Organization-Rate-Limit-Remaining: 228
X-Organization-Rate-Limit-Reset: 1493373360
Strict-Transport-Security: max-age=31536000
X-Server-Name: 1-1

Body

Copy{
    "alert": [
        {
            "alertId": "2783",
            "testId": 822,
            "ruleId": 142,
            "testName": "thousandeyes.com A",
            "active": 1,
            "ruleExpression": "((probDetail != \"\"))",
            "dateStart": "2012-12-13 13:15:00",
            "violationCount": 6,
            "ruleName": "Default DNSSEC Alert Rule",
            "createLinks": true,
            "permalink": "https://app.thousandeyes.com/alerts/list?__a=75&alertId=2783",
            "type": "DNSSEC",
            "agents": [
                {
                    "agentId": 12,
                    "agentName": "Hong Kong",
                    "dateStart": "2012-12-13 13:15:00",
                    "active": 1,
                    "metricsAtStart": "Error details: \"No DNSSEC public key(s) for thousandeyes.com A\"",
                    "metricsAtEnd": "Error details: \"No DNSSEC public key(s) for thousandeyes.com A\"",
                    "permalink": "https://app.thousandeyes.com/alerts/list?__a=75&alertId=2783&agentId=12"
                },
                ...
            ],
            "apiLinks": [...],
            "severity": "INFO",
            "suppressed": 0,
            "metadata": {
                "version":  1
            }
        }
    ],
    "pages": {
        "current": 1
    }
}

For error responses, see the response status codes documentation.