Interface ILiveToolsDhcpLeases

Namespace

Meraki.Api.Interfaces.General.LiveTools

Assembly

Meraki.Api.dll

I Live Tools Dhcp Leases

public interface ILiveToolsDhcpLeases

Methods

CreateDeviceLiveToolsDhcpLeaseAsync(string, DeviceLiveToolsDhcpLeaseCreateRequest, CancellationToken)

Enqueue a job to perform a DHCP leases request for the device. This endpoint currently supports all devices. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

[Post("/devices/{serial}/liveTools/dhcpLeases")]
Task<DeviceLiveToolsDhcpLeaseCreateResponse> CreateDeviceLiveToolsDhcpLeaseAsync(string serial, DeviceLiveToolsDhcpLeaseCreateRequest request, CancellationToken cancellationToken = default)

Parameters

serial string

request DeviceLiveToolsDhcpLeaseCreateRequest

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsDhcpLeaseCreateResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceLiveToolsDhcpLeaseAsync(string, string, CancellationToken)

Return a DHCP leases live tool job.

[Get("/devices/{serial}/liveTools/dhcpLeases/{dhcpLeasesId}")]
Task<DeviceLiveToolsDhcpLeaseGetResponse> GetDeviceLiveToolsDhcpLeaseAsync(string serial, string dhcpLeasesId, CancellationToken cancellationToken = default)

Parameters

serial string

dhcpLeasesId string

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsDhcpLeaseGetResponse>

Exceptions

ApiException

Thrown when fails to make API call