Interface IOrganizationsApplianceSecurityEvents

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsApplianceSecurityEvents

Methods

GetOrganizationApplianceSecurityEventsAsync(string, string, string, int, int, string?, string?, string, CancellationToken)

List the security events for an organization

[Get("/organizations/{organizationId}/appliance/security/events")]
Task<List<SecurityEvent>> GetOrganizationApplianceSecurityEventsAsync(string organizationId, string t0, string t1, int timespan = 31, int perPage = 100, string? startingBefore = null, string? endingBefore = null, string sortOrder = "ascending", CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

t0 string

The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today.

t1 string

The end of the timespan for the data. t1 can be a maximum of 365 days after t0.

timespan int

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 31 days.

perPage int

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.

startingBefore 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.

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.

sortOrder string

Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order.

cancellationToken CancellationToken

Returns

Task<List<SecurityEvent>>

Exceptions

ApiException

Thrown when fails to make API call