Interface IApplianceVpnStats

Namespace

Meraki.Api.Interfaces.Products.Appliance

Assembly

Meraki.Api.dll

public interface IApplianceVpnStats

Methods

GetOrganizationApplianceVpnStatsAsync(string, int?, string?, string?, List<string>?, string?, string?, double?, CancellationToken)

Show VPN history stat for networks in an organization.

[Get("/organizations/{organizationId}/appliance/vpn/stats")]
Task<List<VpnStats>> GetOrganizationApplianceVpnStatsAsync(string organizationId, int? perPage = 300, string? startingAfter = null, string? endingBefore = null, List<string>? networkIds = null, string? t0 = null, string? t1 = null, double? timespan = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id.

perPage int?

The number of entries per page returned. Acceptable range is 3 - 300. Default is 300.

startingAfter string

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

endingBefore string

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

networkIds List<string>

A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456

t0 string

The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

t1 string

The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

timespan double?

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

cancellationToken CancellationToken

Returns

Task<List<VpnStats>>

Exceptions

ApiException

Thrown when fails to make API call.