Interface ISecureConnectDeploymentsOrganizationTunnel

Namespace

Meraki.Api.Interfaces.SecureConnect.Deployments

Assembly

Meraki.Api.dll

I Secure Connect Deployments Organization Tunnel

public interface ISecureConnectDeploymentsOrganizationTunnel

Methods

AddTunnelAsync(long, SecureConnectTunnelCreateRequest, CancellationToken)

Add a new tunnel to the organization.

[Post("/organizations/{organizationId}/tunnels")]
Task<SecureConnectTunnel> AddTunnelAsync(long organizationId, SecureConnectTunnelCreateRequest secureConnectTunnelCreateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

secureConnectTunnelCreateRequest SecureConnectTunnelCreateRequest

The tunnel to create.

cancellationToken CancellationToken

Cancellation token

Returns

Task<SecureConnectTunnel>

Exceptions

ApiException

Thrown when fails to make API call

DeleteTunnelAsync(long, int, SecureConnectTunnelDeleteRequest?, CancellationToken)

Delete a tunnel in the organization.

[Delete("/organizations/{organizationId}/tunnels/{id}")]
Task DeleteTunnelAsync(long organizationId, int id, SecureConnectTunnelDeleteRequest? secureConnectTunnelDeleteRequest, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

id int

The ID of the tunnel.

secureConnectTunnelDeleteRequest SecureConnectTunnelDeleteRequest

Provide the tunnel to delete.y

cancellationToken CancellationToken

Cancellation token

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetTunnelAsync(long, int, CancellationToken)

Get a specific tunnel.

[Get("/organizations/{organizationId}/tunnels/{id}")]
Task<SecureConnectTunnel> GetTunnelAsync(long organizationId, int id, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

id int

The ID of the tunnel.

cancellationToken CancellationToken

Cancellation token

Returns

Task<SecureConnectTunnel>

Exceptions

ApiException

Thrown when fails to make API call

GetTunnelPoliciesAsync(long, int, string?, int?, int?, CancellationToken)

List the policies that include the network tunnel.

[Get("/organizations/{organizationId}/tunnels/{id}/policies")]
Task<List<SecureConnectTunnelPolicy>> GetTunnelPoliciesAsync(long organizationId, int id, string? type, int? limit, int? page, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

id int

The ID of the tunnel.

type string

Filter the list of policies to only include the specified type. enum = ["firewallrule", "web"]

limit int?

The number of items to return in the collection.

page int?

The number of a page in the collection. Use with the limit parameter to implement pagination.

cancellationToken CancellationToken

Cancellation token

Returns

Task<List<SecureConnectTunnelPolicy>>

Exceptions

ApiException

Thrown when fails to make API call

ListTunnelsAsync(long, bool?, int?, string?, string?, CancellationToken)

List the tunnels for an organization.

[Get("/organizations/{organizationId}/tunnels")]
Task<List<SecureConnectTunnel>> ListTunnelsAsync(long organizationId, bool? includeState, int? limit, string? startKey, string? filters, CancellationToken cancellationToken = default)

Parameters

organizationId long

Organization ID associated with this resource.

includeState bool?

Specify whether to include the tunnel state information in the response. default = false

limit int?

The number of items to return in the collection. If not set, all tunnels are returned.

startKey string

Specify where to start reading in the tunnel collection (startKey correlates to the first tunnel to return). If the startKey query parameter is not included in the API request, Umbrella reads the collection from the first available tunnel. When the API request includes the limit query parameter and you have more tunnels to read, Umbrella returns the value of startKey for the next tunnel in the hypermedia Link header.

filters string

Filters the tunnel list by tunnel name, device type, service type, status, data center, or site origin ID.For example:{"name": "test","deviceType": "ISR","serviceType": "SIG","status": "UP","dataCenter": "pao1.edc","siteOriginId": 123}

cancellationToken CancellationToken

Cancellation token

Returns

Task<List<SecureConnectTunnel>>

Exceptions

ApiException

Thrown when fails to make API call