Skip to main content
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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "has_alarm": true,
  "needs_enrichment": true,
  "alarm_labels": [
    "<string>"
  ],
  "packet_data": [
    "<string>"
  ],
  "priority": 123,
  "suppressed": true,
  "destinations": [
    {
      "event_count": 123,
      "address": "<string>",
      "hostname": "<string>",
      "fqdn": "<string>",
      "asset_id": "<string>",
      "organisation": "<string>",
      "country": "<string>",
      "canonical": "<string>",
      "name": "<string>",
      "_links": {
        "self": {
          "href": "<string>",
          "templated": true
        }
      }
    }
  ],
  "sources": [
    {
      "event_count": 123,
      "address": "<string>",
      "hostname": "<string>",
      "fqdn": "<string>",
      "asset_id": "<string>",
      "organisation": "<string>",
      "country": "<string>",
      "canonical": "<string>",
      "name": "<string>",
      "_links": {
        "self": {
          "href": "<string>",
          "templated": true
        }
      }
    }
  ],
  "events": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "has_alarm": true,
      "needs_enrichment": true,
      "priority": 123,
      "suppressed": true,
      "source_address": "<string>",
      "source_asset_id": "<string>",
      "source_canonical": "<string>",
      "source_country": "<string>",
      "source_fqdn": "<string>",
      "source_hostname": "<string>",
      "source_name": "<string>",
      "source_organisation": "<string>",
      "destination_address": "<string>",
      "destination_asset_id": "<string>",
      "destination_canonical": "<string>",
      "destination_country": "<string>",
      "destination_fqdn": "<string>",
      "destination_hostname": "<string>",
      "destination_name": "<string>",
      "destination_organisation": "<string>",
      "_links": {
        "self": {
          "href": "<string>",
          "templated": true
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "<string>",
      "templated": true
    }
  }
}

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[]