Interface INetworksEvents

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

public interface INetworksEvents

Methods

GetNetworkEventsAsync(string, string, List<string>, List<string>, string, string, string, string, string, string, string, string, string, string, bool, int?, string, string, CancellationToken)

List the events for the network

[Get("/networks/{networkId}/events")]
Task<NetworkEvents> GetNetworkEventsAsync(string networkId, string productType = null, List<string> includedEventTypes = null, List<string> excludedEventTypes = null, string deviceMac = null, string deviceSerial = null, string deviceName = null, string clientIp = null, string clientMac = null, string clientName = null, string smDeviceMac = null, string smDeviceName = null, string eventDetails = null, string eventSeverity = null, bool isCatalyst = false, int? perPage = 1000, string startingAfter = null, string endingBefore = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

productType string

The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, and cellularGateway (optional)

includedEventTypes List<string>

A list of event types. The returned events will be filtered to only include events with these types. (optional)

excludedEventTypes List<string>

A list of event types. The returned events will be filtered to exclude events with these types. (optional)

deviceMac string

The MAC address of the Meraki device which the list of events will be filtered with (optional)

deviceSerial string

The serial of the Meraki device which the list of events will be filtered with (optional)

deviceName string

The name of the Meraki device which the list of events will be filtered with (optional)

clientIp string

The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)

clientMac string

The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)

clientName string

The name, or partial name, of the client which the list of events will be filtered with (optional)

smDeviceMac string

The MAC address of the Systems Manager device which the list of events will be filtered with (optional)

smDeviceName string

The name of the Systems Manager device which the list of events will be filtered with (optional)

eventDetails string

The details of the event(Catalyst device only) which the list of events will be filtered with

eventSeverity string

The severity of the event(Catalyst device only) which the list of events will be filtered with

isCatalyst bool

Boolean indicating that whether it is a Catalyst device. For Calatyst device, eventDetails and eventSeverity can be used to filter events.

perPage int?

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)

startingAfter string

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)

endingBefore string

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)

cancellationToken CancellationToken

Returns

Task<NetworkEvents>

Exceptions

ApiException

Thrown when fails to make API call