Interface IOrganizationsWirelessMqtt

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

Interface for organization wireless MQTT settings operations

public interface IOrganizationsWirelessMqtt

Extension Methods

IOrganizationsWirelessMqttExtensions.GetOrganizationWirelessMqttSettingsAllAsync(IOrganizationsWirelessMqtt, string, List<string>?, CancellationToken)

Methods

GetOrganizationWirelessMqttSettingsAsync(string, int?, string?, string?, List<string>?, CancellationToken)

Return MQTT Settings for networks GET /organizations/{organizationId}/wireless/mqtt/settings

[Get("/organizations/{organizationId}/wireless/mqtt/settings")]
Task<OrganizationWirelessMqttSettingsResponse> GetOrganizationWirelessMqttSettingsAsync(string organizationId, int? perPage = null, string? startingAfter = null, string? endingBefore = null, List<string>? networkIds = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

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

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>

Optional parameter to filter mqtt settings by network ID.

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationWirelessMqttSettingsResponse>

UpdateOrganizationWirelessMqttSettingsAsync(string, OrganizationWirelessMqttSettingsUpdateRequest, CancellationToken)

Add new broker config for wireless MQTT PUT /organizations/{organizationId}/wireless/mqtt/settings

[Put("/organizations/{organizationId}/wireless/mqtt/settings")]
Task<OrganizationWirelessMqttSettings> UpdateOrganizationWirelessMqttSettingsAsync(string organizationId, OrganizationWirelessMqttSettingsUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

request OrganizationWirelessMqttSettingsUpdateRequest

The wireless MQTT settings to update

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationWirelessMqttSettings>