Class MerakiClientOptions

Namespace

Meraki.Api

Assembly

Meraki.Api.dll

MerakiClient options

public class MerakiClientOptions

Inheritance

object

MerakiClientOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MerakiClientOptions()

public MerakiClientOptions()

Properties

AccessToken

The OAuth access token for Bearer authentication. Either ApiKey or AccessToken must be set, but not both. When set, this will be used for authentication instead of the API key. The token is passed as "Authorization: Bearer {AccessToken}".

public string? AccessToken { get; set; }

Property Value

string

ApiKey

The API key. Either ApiKey or AccessToken must be set, but not both.

public string ApiKey { get; set; }

Property Value

string

ApiNode

The API Node (e.g. "n72"). Shard-direct API access will cease to work in September 2025, so this property CANNOT be used. This is a breaking change.

[Obsolete("Shard-direct API access will cease to work in September 2025.  This is a breaking change.  Do not use this property.", true)]
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

HttpClientInnerTimeoutSeconds

The inner HttpClient timeout in seconds. This is used to set the Timeout on the inner HttpClient used to make requests. Increase this if you are making requests that take a long time to complete.

public double HttpClientInnerTimeoutSeconds { get; set; }

Property Value

double

HttpClientTimeoutSeconds

Allow overriding the HttpClient Timeout - defaults to 600 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

RateLimiter

A rate limiter to apply to all requests made by this client. This can be shared th other clients to ensure that the rate limit is respected across multiple clients.

public IRateLimiter? RateLimiter { get; set; }

Property Value

IRateLimiter

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. As per Meraki's documentation, this should be in the format of "MerakiClient/{version} {company}". See Meraki API User-Agent Formatting.

public string? UserAgent { get; set; }

Property Value

string

Methods

Validate()

Validates the configuration

public void Validate()

Exceptions

ConfigurationException