Skip to main content
The Fleet Alerts resource allows you to view, acknowledge, and resolve alerts triggered by fleet monitoring rules. It also provides alert channel management for notifications.

​
List alerts

Retrieve a paginated list of fleet alerts. 
const alerts = await client.fleet.alerts.list(options?);

​
Parameters

​
options
ListAlertsOptions
Optional filtering and pagination parameters
​
status
string
Filter alerts by status (e.g., ‘open’, ‘acknowledged’, ‘resolved’)
​
severity
string
Filter alerts by severity level
​
device
string
Filter alerts by device UID
​
rule
string
Filter alerts by rule UID
​
limit
number
Maximum number of alerts to return per page
​
cursor
string
Cursor for pagination

​
Returns

​
items
FleetAlert[]
Array of fleet alerts
​
uid
string
Unique identifier for the alert
​
rule
string | null
UID of the rule that triggered this alert
​
device
string | null
UID of the associated device
​
recording
string | null
UID of the associated recording
​
severity
string | null
Alert severity level
​
status
string | null
Alert status (e.g., ‘open’, ‘acknowledged’, ‘resolved’)
​
message
string | null
Alert message
​
triggeredAt
string | null
Timestamp when the alert was triggered
​
acknowledgedAt
string | null
Timestamp when the alert was acknowledged
​
acknowledgedBy
string | null
User who acknowledged the alert
​
resolvedAt
string | null
Timestamp when the alert was resolved
​
resolutionNote
string | null
Note added when resolving the alert
​
createdAt
string | null
Creation timestamp
​
updatedAt
string | null
Last update timestamp
​
nextCursor
string | null
Cursor for the next page of results
​
previousCursor
string | null
Cursor for the previous page of results
​
hasMore
boolean
Whether more results are available

​
Get alert

Retrieve a specific alert by UID. 
const alert = await client.fleet.alerts.get(uid);

​
Parameters

​
uid
string
required
The unique identifier of the alert

​
Returns

​
FleetAlert
object
The requested alert

​
Acknowledge alert

Acknowledge an alert to indicate it has been seen. 
const alert = await client.fleet.alerts.acknowledge(uid);

​
Parameters

​
uid
string
required
The unique identifier of the alert to acknowledge

​
Returns

​
FleetAlert
object
The updated alert with acknowledgment information

​
Resolve alert

Resolve an alert and optionally add a resolution note. 
const alert = await client.fleet.alerts.resolve(uid, options?);

​
Parameters

​
uid
string
required
The unique identifier of the alert to resolve
​
options
ResolveAlertOptions
Resolution details
​
resolutionNote
string
Note describing how the alert was resolved

​
Returns

​
FleetAlert
object
The updated alert with resolution information

​
Alert channels

Alert channels define how and where notifications are sent when alerts are triggered.

​
List alert channels

Retrieve a paginated list of alert channels. 
const channels = await client.fleet.alertChannels.list(options?);

​
Parameters

​
options
object
Optional pagination parameters
​
limit
number
Maximum number of channels to return per page
​
cursor
string
Cursor for pagination

​
Returns

​
items
FleetAlertChannel[]
Array of alert channels
​
uid
string
Unique identifier for the alert channel
​
name
string
Alert channel name
​
type
string | null
Channel type (e.g., ‘email’, ‘slack’, ‘webhook’)
​
config
Record<string, unknown> | null
Channel-specific configuration
​
createdAt
string | null
Creation timestamp
​
updatedAt
string | null
Last update timestamp
​
nextCursor
string | null
Cursor for the next page of results
​
previousCursor
string | null
Cursor for the previous page of results
​
hasMore
boolean
Whether more results are available

​
Create alert channel

Create a new alert notification channel. 
const channel = await client.fleet.alertChannels.create(options);

​
Parameters

​
options
CreateAlertChannelOptions
required
Alert channel creation details
​
name
string
required
Alert channel name
​
type
string
required
Channel type (e.g., ‘email’, ‘slack’, ‘webhook’)
​
config
Record<string, unknown>
required
Channel-specific configuration (varies by type)

​
Returns

​
FleetAlertChannel
object
The newly created alert channel

​
Delete alert channel

Delete an alert channel. 
await client.fleet.alertChannels.delete(uid);

​
Parameters

​
uid
string
required
The unique identifier of the alert channel to delete

​
Returns

Returns void on success.

​
Test alert channel

Send a test notification to verify an alert channel is configured correctly. 
const result = await client.fleet.alertChannels.test(uid);

​
Parameters

​
uid
string
required
The unique identifier of the alert channel to test

​
Returns

​
detail
string
Test result message
​
channel_uid
string
UID of the tested channel
​
channel_type
string
Type of the tested channel

Build docs developers (and LLMs) love

Get started for freeTalk to us