Table of Contents

Interface IOrganizationsSecureConnectSites

Namespace
Meraki.Api.Interfaces.General.Organizations
Assembly
Meraki.Api.dll

I Organizations Secure Connect Sites

public interface IOrganizationsSecureConnectSites
Extension Methods

Methods

CreateOrganizationSecureConnectSiteAsync(string, SecureConnectSiteCreateRequest, CancellationToken)

Enroll sites in this organization to Secure Connect. For an organization, a maximum of 4000 sites can be enrolled if they are in spoke mode or a maximum of 10 sites can be enrolled in hub mode.

[Post("/organizations/{organizationId}/secureConnect/sites")]
Task<SecureConnectSiteCreateResponse> CreateOrganizationSecureConnectSiteAsync(string organizationId, SecureConnectSiteCreateRequest secureConnectSite, CancellationToken cancellationToken = default)

Parameters

organizationId string
secureConnectSite SecureConnectSiteCreateRequest
cancellationToken CancellationToken

Returns

Task<SecureConnectSiteCreateResponse>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationSecureConnectSiteAsync(string, SecureConnectSiteDeleteRequest, CancellationToken)

Detach given sites from Secure Connect

[Delete("/organizations/{organizationId}/secureConnect/sites")]
Task<SecureConnectSiteDeleteResponse> DeleteOrganizationSecureConnectSiteAsync(string organizationId, SecureConnectSiteDeleteRequest secureConnectSite, CancellationToken cancellationToken = default)

Parameters

organizationId string
secureConnectSite SecureConnectSiteDeleteRequest
cancellationToken CancellationToken

Returns

Task<SecureConnectSiteDeleteResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSecureConnectSitesAsync(string, int?, string?, string?, string?, string?, CancellationToken)

List sites in this organization

[Get("/organizations/{organizationId}/secureConnect/sites")]
Task<SecureConnectSitesResponse> GetOrganizationSecureConnectSitesAsync(string organizationId, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, string? search = null, string? enrolledState = null, CancellationToken cancellationToken = default)

Parameters

organizationId string
perPage int?

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

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.

search string

If provided, filters results by search string

enrolledState string

Filter results by sites that have already been enrolled or can be enrolled. Acceptable values are 'enrolled' or 'enrollable'

cancellationToken CancellationToken

Returns

Task<SecureConnectSitesResponse>

Exceptions

ApiException

Thrown when fails to make API call

Edit this page