Interface IOrganizationsAssuranceAlerts

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizationsAssuranceAlerts

Extension Methods

IOrganizationsAssuranceExtensions.GetOrganizationAssuranceAlertsAllAsync(IOrganizationsAssuranceAlerts, string, string?, string?, string?, List<string>?, string?, string?, string?, string?, List<string>?, List<string>?, List<string>?, bool?, bool?, bool?, bool?, CancellationToken)

Methods

DismissOrganizationAssuranceAlertsAsync(string, OrganizationAssuranceAlertIds, CancellationToken)

Dismiss health alerts

[Post("/organizations/{organizationId}/assurance/alerts/dismiss")]
Task DismissOrganizationAssuranceAlertsAsync(string organizationId, OrganizationAssuranceAlertIds organizationAssuranceAlertsDismiss, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

organizationAssuranceAlertsDismiss OrganizationAssuranceAlertIds

The alert ids to be dismissed

cancellationToken CancellationToken

The cancellation token

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationAssuranceAlertAsync(string, string, CancellationToken)

Return a singular Health Alert by its id

[Get("/organizations/{organizationId}/assurance/alerts/{id}")]
Task<OrganizationAssuranceAlert> GetOrganizationAssuranceAlertAsync(string organizationId, string id, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

id string

ID

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationAssuranceAlert>

Exceptions

ApiException

Thrown when fails to make API call

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

Return all health alerts for an organization

[Get("/organizations/{organizationId}/assurance/alerts")]
Task<List<OrganizationAssuranceAlert>> GetOrganizationAssuranceAlertsAsync(string organizationId, int? perPage, string? startingAfter, string? endingBefore, string? sortOrder, string? networkId, string? severity, List<string>? types, string? tsStart, string? tsEnd, string? category, string? sortBy, List<string>? serials, List<string>? deviceTypes, List<string>? deviceTags, bool? active, bool? dismissed, bool? resolved, bool? suppressAlertsForOfflineNodes, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

The number of entries per page returned. Acceptable range is 4 - 300. Default is 30.

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.

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 entries. Order options are 'ascending' and 'descending'. Default is 'ascending'.

networkId string

Optional parameter to filter alerts by network ids.

severity string

Optional parameter to filter by severity type.

types List<string>

Optional parameter to filter by alert type.

tsStart string

Optional parameter to filter by starting timestamp

tsEnd string

Optional parameter to filter by end timestamp

category string

Optional parameter to filter by category.

sortBy string

Optional parameter to set column to sort by.

serials List<string>

Optional parameter to filter by primary device serial

deviceTypes List<string>

Optional parameter to filter by device types

deviceTags List<string>

Optional parameter to filter by device tags

active bool?

Optional parameter to filter by active alerts defaults to true

dismissed bool?

Optional parameter to filter by dismissed alerts defaults to false

resolved bool?

Optional parameter to filter by resolved alerts defaults to false

suppressAlertsForOfflineNodes bool?

When set to true the api will only return connectivity alerts for a given device if that device is in an offline state. This only applies to devices. This is ignored when resolved is true. Example: If a Switch has a VLan Mismatch and is Unreachable. only the Unreachable alert will be returned. Defaults to false.

cancellationToken CancellationToken

The cancellation token

Returns

Task<List<OrganizationAssuranceAlert>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationAssuranceAlertsOverviewAsync(string, string?, string?, List<string>?, string?, string?, string?, List<string>?, List<string>?, List<string>?, bool?, bool?, bool?, bool?, CancellationToken)

Return overview of active health alerts for an organization

[Get("/organizations/{organizationId}/assurance/alerts/overview")]
Task<OrganizationAssuranceAlertsOverview> GetOrganizationAssuranceAlertsOverviewAsync(string organizationId, string? networkId, string? severity, List<string>? types, string? tsStart, string? tsEnd, string? category, List<string>? serials, List<string>? deviceTypes, List<string>? deviceTags, bool? active, bool? dismissed, bool? resolved, bool? suppressAlertsForOfflineNodes, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

networkId string

Optional parameter to filter alerts by network ids.

severity string

Optional parameter to filter by severity type.

types List<string>

Optional parameter to filter by alert type.

tsStart string

Optional parameter to filter by starting timestamp

tsEnd string

Optional parameter to filter by end timestamp

category string

Optional parameter to filter by category. "configuration", "connectivity", "device_health", "insights"

serials List<string>

Optional parameter to filter by primary device serial

deviceTypes List<string>

Optional parameter to filter by device types

deviceTags List<string>

Optional parameter to filter by device tags

active bool?

Optional parameter to filter by active alerts defaults to true

dismissed bool?

Optional parameter to filter by dismissed alerts defaults to false

resolved bool?

Optional parameter to filter by resolved alerts defaults to false

suppressAlertsForOfflineNodes bool?

When set to true the api will only return connectivity alerts for a given device if that device is in an offline state. This only applies to devices. This is ignored when resolved is true. Example: If a Switch has a VLan Mismatch and is Unreachable. only the Unreachable alert will be returned. Defaults to false.

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationAssuranceAlertsOverview>

Exceptions

ApiException

Thrown when fails to make API call

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

Return a Summary of Alerts grouped by network and severity

[Get("/organizations/{organizationId}/assurance/alerts/overview/byNetwork")]
Task<OrganizationAssuranceAlertsOverviewByNetwork> GetOrganizationAssuranceAlertsOverviewByNetworkAsync(string organizationId, int? perPage, string? startingAfter, string? endingBefore, string? sortOrder, string? networkId, string? severity, List<string>? types, string? tsStart, string? tsEnd, string? category, List<string>? serials, List<string>? deviceTypes, List<string>? deviceTags, bool? active, bool? dismissed, bool? resolved, bool? suppressAlertsForOfflineNodes, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

The number of entries per page returned. Acceptable range is 4 - 300. Default is 30.

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.

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 entries. Order options are 'ascending' and 'descending'. Default is 'ascending'.

networkId string

Optional parameter to filter alerts by network ids.

severity string

Optional parameter to filter by severity type.

types List<string>

Optional parameter to filter by alert type.

tsStart string

Optional parameter to filter by starting timestamp

tsEnd string

Optional parameter to filter by end timestamp

category string

Optional parameter to filter by category. "configuration", "connectivity", "device_health", "insights"

serials List<string>

Optional parameter to filter by primary device serial

deviceTypes List<string>

Optional parameter to filter by device types

deviceTags List<string>

Optional parameter to filter by device tags

active bool?

Optional parameter to filter by active alerts defaults to true

dismissed bool?

Optional parameter to filter by dismissed alerts defaults to false

resolved bool?

Optional parameter to filter by resolved alerts defaults to false

suppressAlertsForOfflineNodes bool?

When set to true the api will only return connectivity alerts for a given device if that device is in an offline state. This only applies to devices. This is ignored when resolved is true. Example: If a Switch has a VLan Mismatch and is Unreachable. only the Unreachable alert will be returned. Defaults to false.

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationAssuranceAlertsOverviewByNetwork>

Exceptions

ApiException

Thrown when fails to make API call

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

Return a Summary of Alerts grouped by type and severity

[Get("/organizations/{organizationId}/assurance/alerts/overview/byType")]
Task<OrganizationAssuranceAlertsOverviewByType> GetOrganizationAssuranceAlertsOverviewByTypeAsync(string organizationId, int? perPage, string? startingAfter, string? endingBefore, string? sortOrder, string? networkId, string? severity, List<string>? types, string? tsStart, string? tsEnd, string? category, string? sortBy, List<string>? serials, List<string>? deviceTypes, List<string>? deviceTags, bool? active, bool? dismissed, bool? resolved, bool? suppressAlertsForOfflineNodes, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

The number of entries per page returned. Acceptable range is 4 - 300. Default is 30.

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.

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 entries. Order options are 'ascending' and 'descending'. Default is 'ascending'.

networkId string

Optional parameter to filter alerts by network ids.

severity string

Optional parameter to filter by severity type.

types List<string>

Optional parameter to filter by alert type.

tsStart string

Optional parameter to filter by starting timestamp

tsEnd string

Optional parameter to filter by end timestamp

category string

Optional parameter to filter by category. "configuration", "connectivity", "device_health", "insights"

sortBy string

Optional parameter to set column to sort by.

serials List<string>

Optional parameter to filter by primary device serial

deviceTypes List<string>

Optional parameter to filter by device types

deviceTags List<string>

Optional parameter to filter by device tags

active bool?

Optional parameter to filter by active alerts defaults to true

dismissed bool?

Optional parameter to filter by dismissed alerts defaults to false

resolved bool?

Optional parameter to filter by resolved alerts defaults to false

suppressAlertsForOfflineNodes bool?

When set to true the api will only return connectivity alerts for a given device if that device is in an offline state. This only applies to devices. This is ignored when resolved is true. Example: If a Switch has a VLan Mismatch and is Unreachable. only the Unreachable alert will be returned. Defaults to false.

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationAssuranceAlertsOverviewByType>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationAssuranceAlertsOverviewHistoricalAsync(string, int, string?, string?, List<string>?, string?, string?, string?, List<string>?, List<string>?, CancellationToken)

Returns historical health alert overviews

[Get("/organizations/{organizationId}/assurance/alerts/overview/historical")]
Task<OrganizationAssuranceAlertsOverviewHistorical> GetOrganizationAssuranceAlertsOverviewHistoricalAsync(string organizationId, int segmentDuration, string? networkId, string? severity, List<string>? types, string? tsStart, string? tsEnd, string? category, List<string>? serials, List<string>? deviceTypes, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

segmentDuration int

Amount of time in seconds for each segment in the returned dataset

networkId string

Optional parameter to filter alerts by network ids.

severity string

Optional parameter to filter by severity type.

types List<string>

Optional parameter to filter by alert type.

tsStart string

Optional parameter to filter by starting timestamp

tsEnd string

Optional parameter to filter by end timestamp

category string

Optional parameter to filter by category. "configuration", "connectivity", "device_health", "insights"

serials List<string>

Optional parameter to filter by primary device serial

deviceTypes List<string>

Optional parameter to filter by device types

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationAssuranceAlertsOverviewHistorical>

Exceptions

ApiException

Thrown when fails to make API call

RestoreOrganizationAssuranceAlertsAsync(string, OrganizationAssuranceAlertIds, CancellationToken)

Restore health alerts from dismissed

[Post("/organizations/{organizationId}/assurance/alerts/restore")]
Task RestoreOrganizationAssuranceAlertsAsync(string organizationId, OrganizationAssuranceAlertIds organizationAssuranceAlertsRestore, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

organizationAssuranceAlertsRestore OrganizationAssuranceAlertIds

The alert ids to restore

cancellationToken CancellationToken

The cancellation token

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call