Interface IOrganizationSensorAlertsProfiles

Namespace

Meraki.Api.Interfaces.Products.Sensor

Assembly

Meraki.Api.dll

public interface IOrganizationSensorAlertsProfiles

Methods

CreateNetworkSensorAlertsProfileAsync(string, SensorAlertsProfileCreateRequest, CancellationToken)

Creates a sensor alert profile for a network

[Post("/networks/{networkId}/sensor/alerts/profiles")]
Task<SensorAlertsProfile> CreateNetworkSensorAlertsProfileAsync(string networkId, SensorAlertsProfileCreateRequest sensorAlertsProfileCreateRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

sensorAlertsProfileCreateRequest SensorAlertsProfileCreateRequest

Body for creating a sensor alert profile

cancellationToken CancellationToken

Returns

Task<SensorAlertsProfile>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkSensorAlertsProfileAsync(string, string, CancellationToken)

Delete a sensor alert profile from a network.

[Delete("/networks/{networkId}/sensor/alerts/profiles/{id}")]
Task DeleteNetworkSensorAlertsProfileAsync(string networkId, string id, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

id string

The sensor alerts profile id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSensorAlertsProfileAsync(string, string, CancellationToken)

Show details of a sensor alert profile for a network

[Get("/networks/{networkId}/sensor/alerts/profiles/{id}")]
Task<SensorAlertsProfile> GetNetworkSensorAlertsProfileAsync(string networkId, string id, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

id string

The profile id

cancellationToken CancellationToken

Returns

Task<SensorAlertsProfile>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSensorAlertsProfilesAsync(string, CancellationToken)

Lists all sensor alert profiles for a network

[Get("/networks/{networkId}/sensor/alerts/profiles")]
Task<List<SensorAlertsProfile>> GetNetworkSensorAlertsProfilesAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<SensorAlertsProfile>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkSensorAlertsProfileAsync(string, string, SensorAlertsProfileUpdateRequest, CancellationToken)

Updates a sensor alert profile for a network

[Put("/networks/{networkId}/sensor/alerts/profiles/{id}")]
Task<SensorAlertsProfile> UpdateNetworkSensorAlertsProfileAsync(string networkId, string id, SensorAlertsProfileUpdateRequest sensorAlertsProfileUpdateRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

id string

The sensor alert profile id

sensorAlertsProfileUpdateRequest SensorAlertsProfileUpdateRequest

Body for updating a sensor alert profile

cancellationToken CancellationToken

Returns

Task<SensorAlertsProfile>

Exceptions

ApiException

Thrown when fails to make API call