Class IOrganizationsApiRequestsExtensions

Namespace

Meraki.Api.Extensions

Assembly

Meraki.Api.dll

public static class IOrganizationsApiRequestsExtensions

Inheritance

object

IOrganizationsApiRequestsExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetOrganizationApiRequestsAllAsync(IOrganizationsApiRequests, string, string?, string?, double?, string?, string?, string?, int?, string?, string?, int?, List<string>?, CancellationToken)

List the API requests made by an organization

public static Task<List<ApiUsage>> GetOrganizationApiRequestsAllAsync(this IOrganizationsApiRequests organizationsApiRequests, string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, string? adminId = null, string? path = null, string? method = null, int? responseCode = null, string? sourceIp = null, string? userAgent = null, int? version = null, List<string>? operationIds = null, CancellationToken cancellationToken = default)

Parameters

organizationsApiRequests IOrganizationsApiRequests

organizationId string

The organization id

t0 string

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

t1 string

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

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 31 days. (optional)

adminId string

Filter the results by the ID of the admin who made the API requests (optional)

path string

Filter the results by the path of the API requests (optional)

method string

Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)

responseCode int?

Filter the results by the response code of the API requests (optional)

sourceIp string

Filter the results by the IP address of the originating API request (optional)

userAgent string

Filter the results by the user agent string of the API request

version int?

Filter the results by the API version of the API request

operationIds List<string>

Filter the results by one or more operation IDs for the API request

cancellationToken CancellationToken

Returns

Task<List<ApiUsage>>

Exceptions

ApiException

Thrown when fails to make API call