Search
Preparing search index...
The search index is not available
@ngrok/ngrok-api
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@ngrok/ngrok-api
datatypes
Module datatypes
Index
Interfaces
APIKey
APIKey
Create
APIKey
List
APIKey
Update
AWSAuth
AWSCredentials
AWSRole
Abuse
Report
Abuse
Report
Create
Abuse
Report
Hostname
Agent
Ingress
Agent
Ingress
Cert
Job
Agent
Ingress
Cert
Policy
Agent
Ingress
Cert
Status
Agent
Ingress
Create
Agent
Ingress
List
Agent
Ingress
Update
Application
Session
Application
Session
List
Application
User
Application
User
List
Bot
User
Bot
User
Create
Bot
User
List
Bot
User
Update
Browser
Session
Certificate
Authority
Certificate
Authority
Create
Certificate
Authority
List
Certificate
Authority
Update
Credential
Credential
Create
Credential
List
Credential
Update
Edge
Backend
Replace
EdgeIPRestriction
Replace
Edge
MutualTLSReplace
Edge
Route
Backend
Replace
Edge
Route
Circuit
Breaker
Replace
Edge
Route
Compression
Replace
Edge
RouteIPRestriction
Replace
Edge
Route
Item
Edge
RouteOAuth
Replace
Edge
RouteOIDCReplace
Edge
Route
Request
Headers
Replace
Edge
Route
Response
Headers
Replace
Edge
RouteSAMLReplace
Edge
Route
Traffic
Policy
Replace
Edge
Route
User
Agent
Filter
Replace
Edge
Route
Webhook
Verification
Replace
Edge
Route
WebsocketTCPConverter
Replace
EdgeTLSTermination
AtEdge
Replace
EdgeTLSTermination
Replace
Edge
Traffic
Policy
Replace
Empty
Endpoint
Endpoint
Backend
Endpoint
Backend
Mutate
Endpoint
Circuit
Breaker
Endpoint
Compression
Endpoint
Create
EndpointIPPolicy
EndpointIPPolicy
Mutate
Endpoint
List
Endpoint
MutualTLS
Endpoint
MutualTLSMutate
EndpointOAuth
EndpointOAuth
Amazon
EndpointOAuth
Facebook
EndpointOAuth
Git
Hub
EndpointOAuth
Git
Lab
EndpointOAuth
Google
EndpointOAuth
Linked
In
EndpointOAuth
Microsoft
EndpointOAuth
Provider
EndpointOAuth
Twitch
EndpointOIDC
Endpoint
Request
Headers
Endpoint
Response
Headers
EndpointSAML
EndpointSAMLMutate
EndpointTLSTermination
EndpointTLSTermination
AtEdge
Endpoint
Traffic
Policy
Endpoint
Update
Endpoint
User
Agent
Filter
Endpoint
Webhook
Validation
Endpoint
WebsocketTCPConverter
Error
Event
Destination
Event
Destination
Create
Event
Destination
List
Event
Destination
Update
Event
Source
Event
Source
Create
Event
Source
Item
Event
Source
List
Event
Source
Paging
Event
Source
Replace
Event
Source
Update
Event
Subscription
Event
Subscription
Create
Event
Subscription
List
Event
Subscription
Update
Event
Target
Event
Target
Azure
Logs
Ingestion
Event
Target
Cloudwatch
Logs
Event
Target
Datadog
Event
Target
Firehose
Event
Target
Kinesis
Failover
Backend
Failover
Backend
Create
Failover
Backend
List
Failover
Backend
Update
HTTPResponse
Backend
HTTPResponse
Backend
Create
HTTPResponse
Backend
List
HTTPResponse
Backend
Update
HTTPSEdge
HTTPSEdge
Create
HTTPSEdge
List
HTTPSEdge
Route
HTTPSEdge
Route
Create
HTTPSEdge
Route
Update
HTTPSEdge
Update
IPPolicy
IPPolicy
Create
IPPolicy
List
IPPolicy
Rule
IPPolicy
Rule
Create
IPPolicy
Rule
List
IPPolicy
Rule
Update
IPPolicy
Update
IPRestriction
IPRestriction
Create
IPRestriction
List
IPRestriction
Update
Identity
Provider
Item
Location
Paging
Ref
Reserved
Addr
Reserved
Addr
Create
Reserved
Addr
List
Reserved
Addr
Update
Reserved
Domain
Reserved
Domain
Cert
Job
Reserved
Domain
Cert
Policy
Reserved
Domain
Cert
Status
Reserved
Domain
Create
Reserved
Domain
List
Reserved
Domain
Update
SSHCertificate
Authority
SSHCertificate
Authority
Create
SSHCertificate
Authority
List
SSHCertificate
Authority
Update
SSHCredential
SSHCredential
Create
SSHCredential
List
SSHCredential
Update
SSHHost
Certificate
SSHHost
Certificate
Create
SSHHost
Certificate
List
SSHHost
Certificate
Update
SSHUser
Certificate
SSHUser
Certificate
Create
SSHUser
Certificate
List
SSHUser
Certificate
Update
Static
Backend
Static
Backend
Create
Static
Backend
List
Static
BackendTLS
Static
Backend
Update
TCPEdge
TCPEdge
Create
TCPEdge
List
TCPEdge
Update
TLSCertificate
TLSCertificate
Create
TLSCertificate
List
TLSCertificateSANs
TLSCertificate
Update
TLSEdge
TLSEdge
Create
TLSEdge
List
TLSEdge
Update
Tunnel
Tunnel
Group
Backend
Tunnel
Group
Backend
Create
Tunnel
Group
Backend
List
Tunnel
Group
Backend
Update
Tunnel
List
Tunnel
Session
Tunnel
Session
List
Tunnel
Sessions
Update
User
Agent
Weighted
Backend
Weighted
Backend
Create
Weighted
Backend
List
Weighted
Backend
Update
Modules
client
datatypes
services
APIKey
APIKey
Create
APIKey
List
APIKey
Update
AWSAuth
AWSCredentials
AWSRole
Abuse
Report
Abuse
Report
Create
Abuse
Report
Hostname
Agent
Ingress
Agent
Ingress
Cert
Job
Agent
Ingress
Cert
Policy
Agent
Ingress
Cert
Status
Agent
Ingress
Create
Agent
Ingress
List
Agent
Ingress
Update
Application
Session
Application
Session
List
Application
User
Application
User
List
Bot
User
Bot
User
Create
Bot
User
List
Bot
User
Update
Browser
Session
Certificate
Authority
Certificate
Authority
Create
Certificate
Authority
List
Certificate
Authority
Update
Credential
Credential
Create
Credential
List
Credential
Update
Edge
Backend
Replace
EdgeIPRestriction
Replace
Edge
MutualTLSReplace
Edge
Route
Backend
Replace
Edge
Route
Circuit
Breaker
Replace
Edge
Route
Compression
Replace
Edge
RouteIPRestriction
Replace
Edge
Route
Item
Edge
RouteOAuth
Replace
Edge
RouteOIDCReplace
Edge
Route
Request
Headers
Replace
Edge
Route
Response
Headers
Replace
Edge
RouteSAMLReplace
Edge
Route
Traffic
Policy
Replace
Edge
Route
User
Agent
Filter
Replace
Edge
Route
Webhook
Verification
Replace
Edge
Route
WebsocketTCPConverter
Replace
EdgeTLSTermination
AtEdge
Replace
EdgeTLSTermination
Replace
Edge
Traffic
Policy
Replace
Empty
Endpoint
Endpoint
Backend
Endpoint
Backend
Mutate
Endpoint
Circuit
Breaker
Endpoint
Compression
Endpoint
Create
EndpointIPPolicy
EndpointIPPolicy
Mutate
Endpoint
List
Endpoint
MutualTLS
Endpoint
MutualTLSMutate
EndpointOAuth
EndpointOAuth
Amazon
EndpointOAuth
Facebook
EndpointOAuth
Git
Hub
EndpointOAuth
Git
Lab
EndpointOAuth
Google
EndpointOAuth
Linked
In
EndpointOAuth
Microsoft
EndpointOAuth
Provider
EndpointOAuth
Twitch
EndpointOIDC
Endpoint
Request
Headers
Endpoint
Response
Headers
EndpointSAML
EndpointSAMLMutate
EndpointTLSTermination
EndpointTLSTermination
AtEdge
Endpoint
Traffic
Policy
Endpoint
Update
Endpoint
User
Agent
Filter
Endpoint
Webhook
Validation
Endpoint
WebsocketTCPConverter
Error
Event
Destination
Event
Destination
Create
Event
Destination
List
Event
Destination
Update
Event
Source
Event
Source
Create
Event
Source
Item
Event
Source
List
Event
Source
Paging
Event
Source
Replace
Event
Source
Update
Event
Subscription
Event
Subscription
Create
Event
Subscription
List
Event
Subscription
Update
Event
Target
Event
Target
Azure
Logs
Ingestion
Event
Target
Cloudwatch
Logs
Event
Target
Datadog
Event
Target
Firehose
Event
Target
Kinesis
Failover
Backend
Failover
Backend
Create
Failover
Backend
List
Failover
Backend
Update
HTTPResponse
Backend
HTTPResponse
Backend
Create
HTTPResponse
Backend
List
HTTPResponse
Backend
Update
HTTPSEdge
HTTPSEdge
Create
HTTPSEdge
List
HTTPSEdge
Route
HTTPSEdge
Route
Create
HTTPSEdge
Route
Update
HTTPSEdge
Update
IPPolicy
IPPolicy
Create
IPPolicy
List
IPPolicy
Rule
IPPolicy
Rule
Create
IPPolicy
Rule
List
IPPolicy
Rule
Update
IPPolicy
Update
IPRestriction
IPRestriction
Create
IPRestriction
List
IPRestriction
Update
Identity
Provider
Item
Location
Paging
Ref
Reserved
Addr
Reserved
Addr
Create
Reserved
Addr
List
Reserved
Addr
Update
Reserved
Domain
Reserved
Domain
Cert
Job
Reserved
Domain
Cert
Policy
Reserved
Domain
Cert
Status
Reserved
Domain
Create
Reserved
Domain
List
Reserved
Domain
Update
SSHCertificate
Authority
SSHCertificate
Authority
Create
SSHCertificate
Authority
List
SSHCertificate
Authority
Update
SSHCredential
SSHCredential
Create
SSHCredential
List
SSHCredential
Update
SSHHost
Certificate
SSHHost
Certificate
Create
SSHHost
Certificate
List
SSHHost
Certificate
Update
SSHUser
Certificate
SSHUser
Certificate
Create
SSHUser
Certificate
List
SSHUser
Certificate
Update
Static
Backend
Static
Backend
Create
Static
Backend
List
Static
BackendTLS
Static
Backend
Update
TCPEdge
TCPEdge
Create
TCPEdge
List
TCPEdge
Update
TLSCertificate
TLSCertificate
Create
TLSCertificate
List
TLSCertificateSANs
TLSCertificate
Update
TLSEdge
TLSEdge
Create
TLSEdge
List
TLSEdge
Update
Tunnel
Tunnel
Group
Backend
Tunnel
Group
Backend
Create
Tunnel
Group
Backend
List
Tunnel
Group
Backend
Update
Tunnel
List
Tunnel
Session
Tunnel
Session
List
Tunnel
Sessions
Update
User
Agent
Weighted
Backend
Weighted
Backend
Create
Weighted
Backend
List
Weighted
Backend
Update
Generated using
TypeDoc