endpoints

Documentation

Index

• type Client
  • func NewClient(cfg *ngrok.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, arg *ngrok.EndpointCreate) (*ngrok.Endpoint, error)
  • func (c *Client) Delete(ctx context.Context, id string) error
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.Endpoint, error)
  • func (c *Client) List(paging *ngrok.Paging) ngrok.Iter[*ngrok.Endpoint]
  • func (c *Client) Update(ctx context.Context, arg *ngrok.EndpointUpdate) (*ngrok.Endpoint, error)

Types

type Client

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

func NewClient

func NewClient(cfg *ngrok.ClientConfig) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, arg *ngrok.EndpointCreate) (*ngrok.Endpoint, error)

Create an endpoint, currently available only for cloud endpoints

https://ngrok.com/docs/api#api-endpoints-create

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, id string) error

Delete an Endpoint by ID, currently available only for cloud endpoints

https://ngrok.com/docs/api#api-endpoints-delete

func (*Client) Get

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

Get the status of an endpoint by ID

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

func (*Client) List

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

List all active endpoints on the account

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

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.EndpointUpdate) (*ngrok.Endpoint, error)

Update an Endpoint by ID, currently available only for cloud endpoints

https://ngrok.com/docs/api#api-endpoints-update