tunnels

Documentation

Index

• type Client
  • func NewClient(cfg *ngrok.ClientConfig) *Client
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.Tunnel, error)
  • func (c *Client) List(paging *ngrok.Paging) ngrok.Iter[*ngrok.Tunnel]

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg *ngrok.ClientConfig) *Client

func (*Client) Get

func (c *Client) Get(ctx context.Context, id string) (*ngrok.Tunnel, error)

Get the status of a tunnel by ID

https://ngrok.com/docs/api#api-tunnels-get

func (*Client) List

func (c *Client) List(paging *ngrok.Paging) ngrok.Iter[*ngrok.Tunnel]

List all online tunnels currently running on the account.

https://ngrok.com/docs/api#api-tunnels-list