Class MerakiClientOptions

Namespace

Meraki.Api

Assembly

Meraki.Api.dll

MerakiClient options

public class MerakiClientOptions

Inheritance

object

MerakiClientOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApiKey

The API key

public string ApiKey { get; set; }

Property Value

string

ApiNode

The API Node (e.g. "n72"). This is optional, but highly recommended as directly addressing the correct instance will reduce propagation delays. If this is NOT provided, you may experience 404 errors when accessing recently-added objects.

public string? ApiNode { get; set; }

Property Value

string

ApiRegion

The API Region. Defaults to "World", which is the default region for the Meraki Dashboard API. Only change this if you are using the China API endpoint.

public ApiRegion ApiRegion { get; set; }

Property Value

ApiRegion

BackOffDelayFactor

This is the exponential factor by which the API Retry-After duration is increased on each attempt. e.g. 1.0 = no change, 1.5 = 50% increase, 2.0 = double Defaults to 1.0

public double BackOffDelayFactor { get; set; }

Property Value

double

HttpClientTimeoutSeconds

Allow overriding the HttpClient Timeout - defaults to 300 seconds

public int HttpClientTimeoutSeconds { get; set; }

Property Value

int

JsonMissingMemberAction

This gets called when JsonMissingMemberHandling is not Ignore and a missing member occurs

public Action<Type, JsonSerializationException, string>? JsonMissingMemberAction { get; set; }

Property Value

Action<Type, JsonSerializationException, string>

JsonMissingMemberHandling

How to handle missing members

public JsonMissingMemberHandling JsonMissingMemberHandling { get; set; }

Property Value

JsonMissingMemberHandling

JsonMissingMemberResponseLogLevel

The LogLevel at which response JSON will be logged when missing members are encountered. Defaults to None.

public LogLevel JsonMissingMemberResponseLogLevel { get; set; }

Property Value

LogLevel

MaxAttemptCount

When retrying

public int MaxAttemptCount { get; set; }

Property Value

int

MaxBackOffDelaySeconds

When a 429 HttpStatus code is sent, the back-off duration doubles on each attempt. This option sets the maximum back-off duration. Defaults to 30

public int MaxBackOffDelaySeconds { get; set; }

Property Value

int

ReadOnly

When true, only GETs are permitted

public bool ReadOnly { get; set; }

Property Value

bool

UserAgent

An optional User-Agent string to attach to outgoing requests.

public string? UserAgent { get; set; }

Property Value

string

Methods

Validate()

public void Validate()