GET
/
alarms
/
{alarmId}
Get Alarm Details
curl --request GET \
  --url https://your-subdomain.alienvault.cloud/api/2.0/alarms/{alarmId} \
  --header 'Authorization: Bearer <token>'
{
  "uuid": "971918fd-a569-548a-5a80-1ffcda2a8365",
  "has_alarm": false,
  "needs_enrichment": true,
  "priority": 20,
  "suppressed": false,
  "events": [
    {
      "uuid": "f5e69126-dc89-6691-e2e7-6db03905830d"
    }
  ],
  "rule_intent": "Environmental Awareness",
  "status": "open",
  "_links": {
    "self": {
      "href": "https://mysubdomain.aveng.us/api/2.0/alarms/971918fd-a569-548a-5a80-1ffcda2a8365"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
alarmId
string<uuid>
required

The UUID of the alarm to retrieve.

Response

Alarm details retrieved successfully.

​
uuid
string<uuid>
required
​
has_alarm
boolean
required
​
needs_enrichment
boolean
required
​
alarm_labels
string[]
​
packet_data
string[]
​
priority
integer
​
suppressed
boolean
​
destinations
object[]
​
sources
object[]
​
events
object[]
​
_links
object