Interface IOrganizationsAlerts

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IOrganizationsAlerts

Methods

CreateOrganizationAlertsProfileAsync(string, OrganizationAlertProfileCreateRequest, CancellationToken)

Create an organization-wide alert configuration

[Post("/organizations/{organizationId}/alerts/profiles")]
Task<OrganizationAlertProfile> CreateOrganizationAlertsProfileAsync(string organizationId, OrganizationAlertProfileCreateRequest createRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

createRequest OrganizationAlertProfileCreateRequest

Body

cancellationToken CancellationToken

Returns

Task<OrganizationAlertProfile>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationAlertsProfileAsync(string, string, CancellationToken)

Removes an organization-wide alert config

[Delete("/organizations/{organizationId}/alerts/profiles/{alertConfigId}")]
Task DeleteOrganizationAlertsProfileAsync(string organizationId, string alertConfigId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

alertConfigId string

The alert config id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationAlertsProfilesAsync(string, CancellationToken)

List all organization-wide alert configurations

[Get("/organizations/{organizationId}/alerts/profiles")]
Task<List<OrganizationAlertProfile>> GetOrganizationAlertsProfilesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<List<OrganizationAlertProfile>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationAlertsProfileAsync(string, string, OrganizationAlertProfileUpdateRequest, CancellationToken)

Update an organization-wide alert config

[Put("/organizations/{organizationId}/alerts/profiles/{alertConfigId}")]
Task<OrganizationAlertProfile> UpdateOrganizationAlertsProfileAsync(string organizationId, string alertConfigId, OrganizationAlertProfileUpdateRequest updateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

alertConfigId string

The alert config id

updateRequest OrganizationAlertProfileUpdateRequest

Body

cancellationToken CancellationToken

Returns

Task<OrganizationAlertProfile>

Exceptions

ApiException

Thrown when fails to make API call