Table of Contents

Class AlertFilters

Namespace
Meraki.Api.Data
Assembly
Meraki.Api.dll
[DataContract]
public class AlertFilters
Inheritance
AlertFilters
Inherited Members

Properties

Clients

Alert Filter Clients

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "clients")]
public List<AlertFiltersClient>? Clients { get; set; }

Property Value

List<AlertFiltersClient>

Conditions

Conditions

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "conditions")]
public List<AlertFiltersCondition>? Conditions { get; set; }

Property Value

List<AlertFiltersCondition>

FailureType

Failure Type

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "failureType")]
public string? FailureType { get; set; }

Property Value

string

LookbackWindow

Loopback Window (in sec) - The summary description does not match the property name but it is as documented 2024-04-15

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "lookbackWindow")]
public int? LookbackWindow { get; set; }

Property Value

int?

MinDuration

Min Duration

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "minDuration")]
public int? MinDuration { get; set; }

Property Value

int?

Name

Name

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "name")]
public string? Name { get; set; }

Property Value

string

PeriodSeconds

The period for the alert in seconds. Set for:

  • UsageAlert (e.g. 1200)
[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "period")]
public long? PeriodSeconds { get; set; }

Property Value

long?

Priority

Priority

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "priority")]
public string? Priority { get; set; }

Property Value

string

Regex

Regex

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "regex")]
public string? Regex { get; set; }

Property Value

string

Selector

A selector in a form dependent on the AlertType: SignalToNoiseRatio: (e.g. {"configs":[{"duration":5,"threshold":"low","ssidNum":null}]} ) HighWirelessUsage: (e.g. {"configs":[{"duration":5,"threshold":"low","ssidNum":null}]} ) Onboarding: (e.g. {"smartSensitivity":"medium","smartEnabled":false,"eventReminderPeriodSecs":10800,"configs":[{"duration":15,"threshold":"medium","ssidNum":null,"assoc":true,"auth":true,"dhcp":true,"dns":true}]} ) PortDown: (e.g. "any port" ) PortError: (e.g. "any port" ) PortSpeed: (e.g. "any port" )

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "selector")]
public string? Selector { get; set; }

Property Value

string

Serials

Serials

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "serials")]
public List<string>? Serials { get; set; }

Property Value

List<string>

SsidNum

SSID Number

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "ssidNum")]
public int? SsidNum { get; set; }

Property Value

int?

Tag

Tag

[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "tag")]
public string? Tag { get; set; }

Property Value

string

Threshold

The threshold for the alert. Set for:

  • UsageAlert in bytes (e.g. 104857600)
  • SensorBatteryPercentage in % (e.g. 5)
[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "threshold")]
public long? Threshold { get; set; }

Property Value

long?

TimeoutMinutes

The timeout in minutes for the alert. Set for:

  • GatewayDown
  • RepeaterDown
  • PortDown
  • SwitchDown
  • CameraDown
  • SensorDown
[ApiAccess(ApiAccess.ReadUpdate)]
[DataMember(Name = "timeout")]
public int? TimeoutMinutes { get; set; }

Property Value

int?