Skip to main content
The Fleet Rules resource allows you to create automated monitoring rules that can trigger actions based on conditions.

List rules

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

Parameters

options
ListRulesOptions
Optional filtering and pagination parameters
enabled
boolean
Filter rules by enabled status
limit
number
Maximum number of rules to return per page
cursor
string
Cursor for pagination

Returns

items
FleetRule[]
Array of fleet rules
uid
string
Unique identifier for the rule
name
string
Rule name
description
string | null
Rule description
enabled
boolean
Whether the rule is enabled
condition
Record<string, unknown> | null
Rule condition configuration
actions
Array<Record<string, unknown>>
Actions to execute when rule is triggered
scope
Record<string, unknown> | null
Rule scope configuration
hitCount
number
Number of times the rule has been triggered
lastHitAt
string | null
Timestamp when the rule was last triggered
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 rule

Create a new fleet monitoring rule.
const rule = await client.fleet.rules.create(options);

Parameters

options
CreateRuleOptions
required
Rule creation details
name
string
required
Rule name
condition
Record<string, unknown>
required
Rule condition configuration defining when the rule triggers
actions
Array<Record<string, unknown>>
required
Actions to execute when the rule is triggered
description
string
Rule description
enabled
boolean
Whether the rule should be enabled (defaults to true)
scope
Record<string, unknown>
Rule scope configuration to limit which devices/recordings this applies to

Returns

FleetRule
object
The newly created rule

Get rule

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

Parameters

uid
string
required
The unique identifier of the rule

Returns

FleetRule
object
The requested rule

Update rule

Update an existing rule.
const rule = await client.fleet.rules.update(uid, options);

Parameters

uid
string
required
The unique identifier of the rule
options
UpdateRuleOptions
required
Fields to update
name
string
Updated rule name
description
string
Updated rule description
enabled
boolean
Updated enabled status
condition
Record<string, unknown>
Updated rule condition
actions
Array<Record<string, unknown>>
Updated actions
scope
Record<string, unknown>
Updated scope configuration

Returns

FleetRule
object
The updated rule

Delete rule

Delete a rule from your fleet.
await client.fleet.rules.delete(uid);

Parameters

uid
string
required
The unique identifier of the rule to delete

Returns

Returns void on success.

Build docs developers (and LLMs) love