Interface IDevices

Namespace

Meraki.Api.Interfaces.General.Devices

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface IDevices

Methods

BlinkDeviceLedsAsync(string, BlinkLeds, CancellationToken)

Blink the LEDs on a device

[Obsolete("Deprecated in Meraki API v1.53 in favour of General.LiveTools.CreateDeviceLiveToolsLedsBlink")]
[Post("/devices/{serial}/blinkLeds")]
Task<BlinkLeds> BlinkDeviceLedsAsync(string serial, BlinkLeds blinkLeds, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

blinkLeds BlinkLeds

Body for blinking device leds

cancellationToken CancellationToken

Returns

Task<BlinkLeds>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceAsync(string, CancellationToken)

Return a single device

[Get("/devices/{serial}")]
Task<Device> GetDeviceAsync(string serial, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

cancellationToken CancellationToken

Returns

Task<Device>

Exceptions

ApiException

Thrown when fails to make API call

RebootDeviceAsync(string, CancellationToken)

Reboot a device

[Post("/devices/{serial}/reboot")]
Task<ActionResponse> RebootDeviceAsync(string serial, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

cancellationToken CancellationToken

Returns

Task<ActionResponse>

Exceptions

ApiException

Thrown when fails to make API call

UpdateDeviceAsync(string, Device, CancellationToken)

Update the attributes of a device

[Put("/devices/{serial}")]
Task<Device> UpdateDeviceAsync(string serial, Device device, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

device Device

Body for updating a device

cancellationToken CancellationToken

Returns

Task<Device>

Exceptions

ApiException

Thrown when fails to make API call