curl --request GET \
--url https://your-subdomain.alienvault.cloud/api/2.0/alarms \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-subdomain.alienvault.cloud/api/2.0/alarms"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-subdomain.alienvault.cloud/api/2.0/alarms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-subdomain.alienvault.cloud/api/2.0/alarms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-subdomain.alienvault.cloud/api/2.0/alarms"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-subdomain.alienvault.cloud/api/2.0/alarms")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-subdomain.alienvault.cloud/api/2.0/alarms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"_links": {
"first": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms?page=0&size=20&sort=timestamp_occured,desc"
},
"self": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms"
},
"next": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms?page=1&size=20&sort=timestamp_occured,desc"
},
"last": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms?page=175&size=20&sort=timestamp_occured,desc"
}
},
"_embedded": {
"alarms": [
{
"uuid": "971918fd-a569-548a-5a80-1ffcda2a8365",
"priority": 20,
"status": "open",
"rule_intent": "Environmental Awareness"
}
]
},
"page": {
"size": 20,
"totalElements": 3506,
"totalPages": 176,
"number": 0
}
}Get a page of alarms
Retrieves a paginated list of alarms. Can be filtered by various parameters.
curl --request GET \
--url https://your-subdomain.alienvault.cloud/api/2.0/alarms \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-subdomain.alienvault.cloud/api/2.0/alarms"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-subdomain.alienvault.cloud/api/2.0/alarms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-subdomain.alienvault.cloud/api/2.0/alarms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-subdomain.alienvault.cloud/api/2.0/alarms"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-subdomain.alienvault.cloud/api/2.0/alarms")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-subdomain.alienvault.cloud/api/2.0/alarms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"_links": {
"first": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms?page=0&size=20&sort=timestamp_occured,desc"
},
"self": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms"
},
"next": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms?page=1&size=20&sort=timestamp_occured,desc"
},
"last": {
"href": "https://mysubdomain.alienvault.cloud/api/2.0/alarms?page=175&size=20&sort=timestamp_occured,desc"
}
},
"_embedded": {
"alarms": [
{
"uuid": "971918fd-a569-548a-5a80-1ffcda2a8365",
"priority": 20,
"status": "open",
"rule_intent": "Environmental Awareness"
}
]
},
"page": {
"size": 20,
"totalElements": 3506,
"totalPages": 176,
"number": 0
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The page number of results to return (zero-based).
The number of results to return per page.
The parameter and direction to sort results by.
"timestamp_occured,asc"
Filter by the status of the alarm.
open, closed, in_review Filter alarms by the suppressed flag.
Filter by the intent of the rule that triggered the alarm.
Filter by the method of the rule that triggered the alarm.
Filter by the strategy of the rule that triggered the alarm.
Filter by the priority of the alarm.
low, medium, high Filter by the UUID of the sensor.
Filter for alarms that occurred at or after this timestamp (epoch milliseconds).
Filter for alarms that occurred at or before this timestamp (epoch milliseconds).