ngrokapi

Documentation

Index

• type Clientset
• type DefaultClientset
  • func NewClientSet(config *ngrok.ClientConfig) *DefaultClientset
  • func (c *DefaultClientset) Domains() *reserved_domains.Client
  • func (c *DefaultClientset) EdgeModules() EdgeModulesClientset
  • func (c *DefaultClientset) HTTPSEdgeRoutes() *https_edge_routes.Client
  • func (c *DefaultClientset) HTTPSEdges() *https_edges.Client
  • func (c *DefaultClientset) IPPolicies() *ip_policies.Client
  • func (c *DefaultClientset) IPPolicyRules() *ip_policy_rules.Client
  • func (c *DefaultClientset) TCPAddresses() *reserved_addrs.Client
  • func (c *DefaultClientset) TCPEdges() *tcp_edges.Client
  • func (c *DefaultClientset) TLSEdges() *tls_edges.Client
  • func (c *DefaultClientset) TunnelGroupBackends() *tunnel_group_backends.Client
• type EdgeModulesClientset
• type EdgeRawTCPPolicyReplace
• type EdgeRawTLSPolicyReplace
• type EdgeRoutePolicyRawReplace
• type HTTPSEdgeModulesClientset
• type HTTPSEdgeRouteModulesClientset
• type RawHTTPSEdgePolicyClient
• type RawTCPEdgePolicyClient
• type RawTLSEdgePolicyClient
• type TCPEdgeModulesClientset
• type TLSEdgeModulesClientset

Examples

• Clientset

Types

type Clientset

type Clientset interface {
	Domains() *reserved_domains.Client
	EdgeModules() EdgeModulesClientset
	HTTPSEdges() *https_edges.Client
	HTTPSEdgeRoutes() *https_edge_routes.Client
	IPPolicies() *ip_policies.Client
	IPPolicyRules() *ip_policy_rules.Client
	TCPAddresses() *reserved_addrs.Client
	TCPEdges() *tcp_edges.Client
	TLSEdges() *tls_edges.Client
	TunnelGroupBackends() *tunnel_group_backends.Client
}

Example

// Create a ngrok client config
config := ngrok.NewClientConfig("YOUR_API_KEY")
// Create a clientset using the provided ngrok client configuration.
cs := NewClientSet(config)
// Access a client for the domains API.
cs.Domains()
// Access a client for TCP Edge modules
cs.EdgeModules().TCP()
// Access a client for HTTPS Edge Route Modules
cs.EdgeModules().HTTPS().Routes().Compression()

type DefaultClientset

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

func NewClientSet

func NewClientSet(config *ngrok.ClientConfig) *DefaultClientset

NewClientSet creates a new ClientSet from an ngrok client config.

func (*DefaultClientset) Domains

func (c *DefaultClientset) Domains() *reserved_domains.Client

func (*DefaultClientset) EdgeModules

func (c *DefaultClientset) EdgeModules() EdgeModulesClientset

func (*DefaultClientset) HTTPSEdgeRoutes

func (c *DefaultClientset) HTTPSEdgeRoutes() *https_edge_routes.Client

func (*DefaultClientset) HTTPSEdges

func (c *DefaultClientset) HTTPSEdges() *https_edges.Client

func (*DefaultClientset) IPPolicies

func (c *DefaultClientset) IPPolicies() *ip_policies.Client

func (*DefaultClientset) IPPolicyRules

func (c *DefaultClientset) IPPolicyRules() *ip_policy_rules.Client

func (*DefaultClientset) TCPAddresses

func (c *DefaultClientset) TCPAddresses() *reserved_addrs.Client

func (*DefaultClientset) TCPEdges

func (c *DefaultClientset) TCPEdges() *tcp_edges.Client

func (*DefaultClientset) TLSEdges

func (c *DefaultClientset) TLSEdges() *tls_edges.Client

func (*DefaultClientset) TunnelGroupBackends

func (c *DefaultClientset) TunnelGroupBackends() *tunnel_group_backends.Client

type EdgeModulesClientset

type EdgeModulesClientset interface {
	TCP() TCPEdgeModulesClientset
	HTTPS() HTTPSEdgeModulesClientset
	TLS() TLSEdgeModulesClientset
}

type EdgeRawTCPPolicyReplace

type EdgeRawTCPPolicyReplace struct {
	ID     string          `json:"id,omitempty"`
	Module json.RawMessage `json:"module,omitempty"`
}

type EdgeRawTLSPolicyReplace

type EdgeRawTLSPolicyReplace struct {
	ID     string          `json:"id,omitempty"`
	Module json.RawMessage `json:"module,omitempty"`
}

type EdgeRoutePolicyRawReplace

type EdgeRoutePolicyRawReplace struct {
	EdgeID string          `json:"edge_id,omitempty"`
	ID     string          `json:"id,omitempty"`
	Module json.RawMessage `json:"module,omitempty"`
}

type HTTPSEdgeModulesClientset

type HTTPSEdgeModulesClientset interface {
	MutualTLS() *https_edge_mutual_tls.Client
	Routes() HTTPSEdgeRouteModulesClientset
	TLSTermination() *https_edge_tls_termination.Client
}

type HTTPSEdgeRouteModulesClientset

type HTTPSEdgeRouteModulesClientset interface {
	Backend() *https_edge_route_backend.Client
	CircuitBreaker() *https_edge_route_circuit_breaker.Client
	Compression() *https_edge_route_compression.Client
	IPRestriction() *https_edge_route_ip_restriction.Client
	OAuth() *https_edge_route_oauth.Client
	Policy() *https_edge_route_policy.Client
	RawPolicy() *rawHTTPSPolicyClient
	OIDC() *https_edge_route_oidc.Client
	RequestHeaders() *https_edge_route_request_headers.Client
	ResponseHeaders() *https_edge_route_response_headers.Client
	SAML() *https_edge_route_saml.Client
	WebhookVerification() *https_edge_route_webhook_verification.Client
	WebsocketTCPConverter() *https_edge_route_websocket_tcp_converter.Client
}

type RawHTTPSEdgePolicyClient

type RawHTTPSEdgePolicyClient interface {
	Delete(context.Context, *ngrok.EdgeRouteItem) error
	Replace(context.Context, EdgeRoutePolicyRawReplace) (*json.RawMessage, error)
}

type RawTCPEdgePolicyClient

type RawTCPEdgePolicyClient interface {
	Delete(context.Context, string) error
	Replace(context.Context, EdgeRawTCPPolicyReplace) (*json.RawMessage, error)
}

type RawTLSEdgePolicyClient

type RawTLSEdgePolicyClient interface {
	Delete(context.Context, string) error
	Replace(context.Context, EdgeRawTLSPolicyReplace) (*json.RawMessage, error)
}

type TCPEdgeModulesClientset

type TCPEdgeModulesClientset interface {
	Backend() *tcp_edge_backend.Client
	IPRestriction() *tcp_edge_ip_restriction.Client
	Policy() *tcp_edge_policy.Client
	RawPolicy() *rawTCPPolicyClient
}

type TLSEdgeModulesClientset

type TLSEdgeModulesClientset interface {
	Backend() *tls_edge_backend.Client
	IPRestriction() *tls_edge_ip_restriction.Client
	MutualTLS() *tls_edge_mutual_tls.Client
	TLSTermination() *tls_edge_tls_termination.Client
	Policy() *tls_edge_policy.Client
	RawPolicy() *rawTLSPolicyClient
}