Class AgentIngresses

Hierarchy

AgentIngresses

Index

Constructors

constructor

Methods

Constructors

constructor

new AgentIngresses(httpClient: Wretcher): AgentIngresses

- Defined in services.ts:47
Do not construct this object directly, use the agentIngresses property of an Ngrok client object instead.

Parameters
- httpClient: Wretcher
Returns AgentIngresses

Methods

create

create(arg: AgentIngressCreate): Promise<AgentIngress>

- Defined in services.ts:53
Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.

Parameters
- arg: AgentIngressCreate
Returns Promise<AgentIngress>

delete

delete(id: any): Promise<void>

- Defined in services.ts:65
Delete an Agent Ingress by ID

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<AgentIngress>

- Defined in services.ts:75
Get the details of an Agent Ingress by ID.

Parameters
- id: any
Returns Promise<AgentIngress>

list

list(beforeId?: string, limit?: string): Promise<AgentIngress[]>

- Defined in services.ts:85
List all Agent Ingresses owned by this account

Parameters
- Optional beforeId: string
- Optional limit: string
Returns Promise<AgentIngress[]>

update

update(arg: AgentIngressUpdate): Promise<AgentIngress>

- Defined in services.ts:135
Update attributes of an Agent Ingress by ID.

Parameters
- arg: AgentIngressUpdate
Returns Promise<AgentIngress>

Generated using TypeDoc