Interface ILiveToolsSpeedTest

Namespace

Meraki.Api.Interfaces.General.LiveTools

Assembly

Meraki.Api.dll

I Live Tools Speed Test

public interface ILiveToolsSpeedTest

Methods

CreateDeviceLiveToolsSpeedTestAsync(string, DeviceLiveToolsSpeedTestCreateRequest, CancellationToken)

Enqueue a job to execute a speed test from a device

[Post("/devices/{serial}/liveTools/speedTest")]
Task<DeviceLiveToolsSpeedTestCreateResponse> CreateDeviceLiveToolsSpeedTestAsync(string serial, DeviceLiveToolsSpeedTestCreateRequest request, CancellationToken cancellationToken = default)

Parameters

serial string

request DeviceLiveToolsSpeedTestCreateRequest

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsSpeedTestCreateResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceLiveToolsSpeedTestAsync(string, string, CancellationToken)

Returns a speed test result in megabits per second. If test is not complete, no results are present.

[Get("/devices/{serial}/liveTools/speedTest/{id}")]
Task<DeviceLiveToolsSpeedTestGetResponse> GetDeviceLiveToolsSpeedTestAsync(string serial, string id, CancellationToken cancellationToken = default)

Parameters

serial string

id string

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsSpeedTestGetResponse>

Exceptions

ApiException

Thrown when fails to make API call