ip_policies

Documentation

Index

• type Client
  • func NewClient(cfg *ngrok.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, arg *ngrok.IPPolicyCreate) (*ngrok.IPPolicy, error)
  • func (c *Client) Delete(ctx context.Context, id string) error
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.IPPolicy, error)
  • func (c *Client) List(paging *ngrok.Paging) ngrok.Iter[*ngrok.IPPolicy]
  • func (c *Client) Update(ctx context.Context, arg *ngrok.IPPolicyUpdate) (*ngrok.IPPolicy, 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.IPPolicyCreate) (*ngrok.IPPolicy, error)

Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.

https://ngrok.com/docs/api#api-ip-policies-create

func (*Client) Delete

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

Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.

https://ngrok.com/docs/api#api-ip-policies-delete

func (*Client) Get

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

Get detailed information about an IP policy by ID.

https://ngrok.com/docs/api#api-ip-policies-get

func (*Client) List

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

List all IP policies on this account

https://ngrok.com/docs/api#api-ip-policies-list

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.IPPolicyUpdate) (*ngrok.IPPolicy, error)

Update attributes of an IP policy by ID

https://ngrok.com/docs/api#api-ip-policies-update