# ngrok integration

> ngrok API for managing endpoints, domains, edges, tunnels, certificates, IP policies, credentials and other ngrok account resources.

- Authentication: apiKey

## Tools (246)

- **Create Abuse Reports**: Creates a new abuse report which will be reviewed by our system and abuse response team. This API is only available to authorized accounts. Contact abuse@ngrok.com to request access
- **Create Agent Ingresses**: 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.
- **Create API Keys**: Create a new API key. The generated API key can be used to authenticate to the ngrok API.
- **Create Bot Users (legacy Service Users)**: Create a new bot user
- **Create Certificate Authorities**: Upload a new Certificate Authority
- **Create Credentials**: Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.
- **Create Endpoints**: Create an endpoint, currently available only for cloud endpoints
- **Create Event Destinations**: Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription.
- **Create Event Sources**: Add an additional type for which this event subscription will trigger
- **Create Event Subscriptions**: Create an Event Subscription.
- **Create Failover Backends**: Create a new Failover backend
- **Create HTTP Response Backends**: Create HTTP Response Backends
- **Create HTTPS Edge Routes**: Create an HTTPS Edge Route
- **Create HTTPS Edges**: Create an HTTPS Edge
- **Create IP Policies**: 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.
- **Create IP Policy Rules**: Create a new IP policy rule attached to an IP Policy.
- **Create IP Restrictions**: Create a new IP restriction
- **Create Kubernetes Operator**: Create a new Kubernetes Operator
- **Create Reserved Addrs**: Create a new reserved address.
- **Create Reserved Domains**: Create a new reserved domain.
- **Create Service User**: Create a new Service User.
- **Create SSH Certificate Authorities**: Create a new SSH Certificate Authority
- **Create SSH Credentials**: Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.
- **Create SSH Host Certificates**: Create a new SSH Host Certificate
- **Create SSH User Certificates**: Create a new SSH User Certificate
- **Create Static Backends**: Create a new static backend
- **Create TCP Edges**: Create a TCP Edge
- **Create TLS Certificates**: Upload a new TLS certificate
- **Create TLS Edges**: Create a TLS Edge
- **Create Tunnel Group Backends**: Create a new TunnelGroup backend
- **Create Vaults**: Create a new Vault
- **Create Vault Secrets**: Create a new Secret
- **Create Weighted Backends**: Create a new Weighted backend
- **Delete Agent Ingresses**: Delete an Agent Ingress by ID
- **Delete API Keys**: Delete an API key by ID
- **Delete Application Sessions**: Delete an application session by ID.
- **Delete Application Users**: Delete an application user by ID.
- **Delete Bot Users (legacy Service Users)**: Delete a bot user by ID
- **Delete Certificate Authorities**: Delete a Certificate Authority
- **Delete Certificate Management Policy of Reserved Domains**: Detach the certificate management policy attached to a reserved domain.
- **Delete Certificate of Reserved Domains**: Detach the certificate attached to a reserved domain.
- **Delete Credentials**: Delete a tunnel authtoken credential by ID
- **Delete Edge Route Backend Module**: Delete Edge Route Backend Module
- **Delete Edge Route Circuit Breaker Module**: Delete Edge Route Circuit Breaker Module
- **Delete Edge Route Compression Module**: Delete Edge Route Compression Module
- **Delete Edge Route IP Restriction Module**: Delete Edge Route IP Restriction Module
- **Delete Edge Route OAuth Module**: Delete Edge Route OAuth Module
- **Delete Edge Route OIDC Module**: Delete Edge Route OIDC Module
- **Delete Edge Route Request Headers Module**: Delete Edge Route Request Headers Module
- **Delete Edge Route Response Headers Module**: Delete Edge Route Response Headers Module
- **Delete Edge Route SAML Module**: Delete Edge Route SAML Module
- **Delete Edge Route Traffic Policy Module**: Delete Edge Route Traffic Policy Module
- **Delete Edge Route User Agent Filter Module**: Delete Edge Route User Agent Filter Module
- **Delete Edge Route Webhook Verification Module**: Delete Edge Route Webhook Verification Module
- **Delete Edge Route Websocket TCP Converter Module**: Delete Edge Route Websocket TCP Converter Module
- **Delete Endpoints**: Delete an Endpoint by ID, currently available only for cloud endpoints
- **Delete Event Destinations**: Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.
- **Delete Event Sources**: Remove a type for which this event subscription will trigger
- **Delete Event Subscriptions**: Delete an Event Subscription.
- **Delete Failover Backends**: Delete a Failover backend by ID.
- **Delete HTTP Response Backends**: Delete HTTP Response Backends
- **Delete HTTPS Edge Mutual TLS Module**: Delete HTTPS Edge Mutual TLS Module
- **Delete HTTPS Edge Routes**: Delete an HTTPS Edge Route by ID
- **Delete HTTPS Edges**: Delete an HTTPS Edge by ID
- **Delete HTTPS Edge TLS Termination Module**: Delete HTTPS Edge TLS Termination Module
- **Delete IP Policies**: 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.
- **Delete IP Policy Rules**: Delete an IP policy rule.
- **Delete IP Restrictions**: Delete an IP restriction
- **Delete Kubernetes Operator**: Delete a Kubernetes Operator
- **Delete Reserved Addrs**: Delete a reserved address.
- **Delete Reserved Domains**: Delete a reserved domain.
- **Delete Service User**: Delete a Service User by ID.
- **Delete SSH Certificate Authorities**: Delete an SSH Certificate Authority
- **Delete SSH Credentials**: Delete an ssh_credential by ID
- **Delete SSH Host Certificates**: Delete an SSH Host Certificate
- **Delete SSH User Certificates**: Delete an SSH User Certificate
- **Delete Static Backends**: Delete a static backend by ID.
- **Delete TCP Edge Backend Module**: Delete TCP Edge Backend Module
- **Delete TCP Edge IP Restriction Module**: Delete TCP Edge IP Restriction Module
- **Delete TCP Edges**: Delete a TCP Edge by ID
- **Delete TCP Edge Traffic Policy Module**: Delete TCP Edge Traffic Policy Module
- **Delete TLS Certificates**: Delete a TLS certificate
- **Delete TLS Edge Backend Module**: Delete TLS Edge Backend Module
- **Delete TLS Edge IP Restriction Module**: Delete TLS Edge IP Restriction Module
- **Delete TLS Edge Mutual TLS Module**: Delete TLS Edge Mutual TLS Module
- **Delete TLS Edges**: Delete a TLS Edge by ID
- **Delete TLS Edge TLS Termination Module**: Delete TLS Edge TLS Termination Module
- **Delete TLS Edge Traffic Policy Module**: Delete TLS Edge Traffic Policy Module
- **Delete Tunnel Group Backends**: Delete a TunnelGroup backend by ID.
- **Delete Vaults**: Delete a Vault
- **Delete Vault Secrets**: Delete a Secret
- **Delete Weighted Backends**: Delete a Weighted backend by ID.
- **Get Abuse Reports**: Get the detailed status of abuse report by ID.
- **Get Agent Ingresses**: Get the details of an Agent Ingress by ID.
- **Get API Keys**: Get the details of an API key by ID.
- **Get Application Sessions**: Get an application session by ID.
- **Get Application Users**: Get an application user by ID.
- **Get Bot Users (legacy Service Users)**: Get the details of a Bot User by ID.
- **Get Certificate Authorities**: Get detailed information about a certificate authority
- **Get Credentials**: Get detailed information about a tunnel authtoken credential
- **Get Edge Route Backend Module**: Get Edge Route Backend Module
- **Get Edge Route Circuit Breaker Module**: Get Edge Route Circuit Breaker Module
- **Get Edge Route Compression Module**: Get Edge Route Compression Module
- **Get Edge Route IP Restriction Module**: Get Edge Route IP Restriction Module
- **Get Edge Route OAuth Module**: Get Edge Route OAuth Module
- **Get Edge Route OIDC Module**: Get Edge Route OIDC Module
- **Get Edge Route Request Headers Module**: Get Edge Route Request Headers Module
- **Get Edge Route Response Headers Module**: Get Edge Route Response Headers Module
- **Get Edge Route SAML Module**: Get Edge Route SAML Module
- **Get Edge Route Traffic Policy Module**: Get Edge Route Traffic Policy Module
- **Get Edge Route User Agent Filter Module**: Get Edge Route User Agent Filter Module
- **Get Edge Route Webhook Verification Module**: Get Edge Route Webhook Verification Module
- **Get Edge Route Websocket TCP Converter Module**: Get Edge Route Websocket TCP Converter Module
- **Get Endpoints**: Get the status of an endpoint by ID
- **Get Event Destinations**: Get detailed information about an Event Destination by ID.
- **Get Event Sources**: Get the details for a given type that triggers for the given event subscription
- **Get Event Subscriptions**: Get an Event Subscription by ID.
- **Get Failover Backends**: Get detailed information about a Failover backend by ID
- **Get HTTP Response Backends**: Get HTTP Response Backends
- **Get HTTPS Edge Mutual TLS Module**: Get HTTPS Edge Mutual TLS Module
- **Get HTTPS Edge Routes**: Get an HTTPS Edge Route by ID
- **Get HTTPS Edges**: Get an HTTPS Edge by ID
- **Get HTTPS Edge TLS Termination Module**: Get HTTPS Edge TLS Termination Module
- **Get IP Policies**: Get detailed information about an IP policy by ID.
- **Get IP Policy Rules**: Get detailed information about an IP policy rule by ID.
- **Get IP Restrictions**: Get detailed information about an IP restriction
- **Get Kubernetes Operator**: Get of a Kubernetes Operator
- **Get Reserved Addrs**: Get the details of a reserved address.
- **Get Reserved Domains**: Get the details of a reserved domain.
- **Get Service User**: Get the details of a Service User by ID.
- **Get SSH Certificate Authorities**: Get detailed information about an SSH Certificate Authority
- **Get SSH Credentials**: Get detailed information about an ssh_credential
- **Get SSH Host Certificates**: Get detailed information about an SSH Host Certificate
- **Get SSH User Certificates**: Get detailed information about an SSH User Certificate
- **Get Static Backends**: Get detailed information about a static backend by ID
- **Get TCP Edge Backend Module**: Get TCP Edge Backend Module
- **Get TCP Edge IP Restriction Module**: Get TCP Edge IP Restriction Module
- **Get TCP Edges**: Get a TCP Edge by ID
- **Get TCP Edge Traffic Policy Module**: Get TCP Edge Traffic Policy Module
- **Get TLS Certificates**: Get detailed information about a TLS certificate
- **Get TLS Edge Backend Module**: Get TLS Edge Backend Module
- **Get TLS Edge IP Restriction Module**: Get TLS Edge IP Restriction Module
- **Get TLS Edge Mutual TLS Module**: Get TLS Edge Mutual TLS Module
- **Get TLS Edges**: Get a TLS Edge by ID
- **Get TLS Edge TLS Termination Module**: Get TLS Edge TLS Termination Module
- **Get TLS Edge Traffic Policy Module**: Get TLS Edge Traffic Policy Module
- **Get Tunnel Group Backends**: Get detailed information about a TunnelGroup backend by ID
- **Get Tunnels**: Get the status of a tunnel by ID
- **Get Tunnel Sessions**: Get the detailed status of a tunnel session by ID
- **Get Vaults**: Get a Vault by ID
- **Get Vault Secrets**: Get a Secret by ID
- **Get Weighted Backends**: Get detailed information about a Weighted backend by ID
- **List Agent Ingresses**: List all Agent Ingresses owned by this account
- **List API Keys**: List all API keys owned by this account
- **List Application Sessions**: List all application sessions for this account.
- **List Application Users**: List all application users for this account.
- **List Bot Users (legacy Service Users)**: List all bot users in this account.
- **List Certificate Authorities**: List all Certificate Authority on this account
- **List Credentials**: List all tunnel authtoken credentials on this account
- **List Endpoints**: List all active endpoints on the account
- **List Event Destinations**: List all Event Destinations on this account.
- **List Event Sources**: List the types for which this event subscription will trigger
- **List Event Subscriptions**: List this Account's Event Subscriptions.
- **List Failover Backends**: List all Failover backends on this account
- **List HTTP Response Backends**: List HTTP Response Backends
- **List HTTPS Edges**: Returns a list of all HTTPS Edges on this account
- **List IP Policies**: List all IP policies on this account
- **List IP Policy Rules**: List all IP policy rules on this account
- **List IP Restrictions**: List all IP restrictions on this account
- **List Kubernetes Operator Bound Endpoints**: List Endpoints bound to a Kubernetes Operator
- **List Kubernetes Operators**: List all Kubernetes Operators owned by this account
- **List Reserved Addrs**: List all reserved addresses on this account.
- **List Reserved Domains**: List all reserved domains on this account.
- **List Service Users**: List all Service Users in this account.
- **List SSH Certificate Authorities**: List all SSH Certificate Authorities on this account
- **List SSH Credentials**: List all ssh credentials on this account
- **List SSH Host Certificates**: List all SSH Host Certificates issued on this account
- **List SSH User Certificates**: List all SSH User Certificates issued on this account
- **List Static Backends**: List all static backends on this account
- **List TCP Edges**: Returns a list of all TCP Edges on this account
- **List TLS Certificates**: List all TLS certificates on this account
- **List TLS Edges**: Returns a list of all TLS Edges on this account
- **List Tunnel Group Backends**: List all TunnelGroup backends on this account
- **List Tunnels**: List all online tunnels currently running on the account.
- **List Tunnel Sessions**: List all online tunnel sessions running on this account.
- **List Vaults**: List all Vaults owned by account
- **List Vault Secrets**: List all Secrets owned by account
- **List Weighted Backends**: List all Weighted backends on this account
- **Replace Edge Route Backend Module**: Replace Edge Route Backend Module
- **Replace Edge Route Circuit Breaker Module**: Replace Edge Route Circuit Breaker Module
- **Replace Edge Route Compression Module**: Replace Edge Route Compression Module
- **Replace Edge Route IP Restriction Module**: Replace Edge Route IP Restriction Module
- **Replace Edge Route OAuth Module**: Replace Edge Route OAuth Module
- **Replace Edge Route OIDC Module**: Replace Edge Route OIDC Module
- **Replace Edge Route Request Headers Module**: Replace Edge Route Request Headers Module
- **Replace Edge Route Response Headers Module**: Replace Edge Route Response Headers Module
- **Replace Edge Route SAML Module**: Replace Edge Route SAML Module
- **Replace Edge Route Traffic Policy Module**: Replace Edge Route Traffic Policy Module
- **Replace Edge Route User Agent Filter Module**: Replace Edge Route User Agent Filter Module
- **Replace Edge Route Webhook Verification Module**: Replace Edge Route Webhook Verification Module
- **Replace Edge Route Websocket TCP Converter Module**: Replace Edge Route Websocket TCP Converter Module
- **Replace HTTPS Edge Mutual TLS Module**: Replace HTTPS Edge Mutual TLS Module
- **Replace HTTPS Edge TLS Termination Module**: Replace HTTPS Edge TLS Termination Module
- **Replace TCP Edge Backend Module**: Replace TCP Edge Backend Module
- **Replace TCP Edge IP Restriction Module**: Replace TCP Edge IP Restriction Module
- **Replace TCP Edge Traffic Policy Module**: Replace TCP Edge Traffic Policy Module
- **Replace TLS Edge Backend Module**: Replace TLS Edge Backend Module
- **Replace TLS Edge IP Restriction Module**: Replace TLS Edge IP Restriction Module
- **Replace TLS Edge Mutual TLS Module**: Replace TLS Edge Mutual TLS Module
- **Replace TLS Edge TLS Termination Module**: Replace TLS Edge TLS Termination Module
- **Replace TLS Edge Traffic Policy Module**: Replace TLS Edge Traffic Policy Module
- **Restart Tunnel Sessions**: Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.
- **Stop Tunnel Sessions**: Issues a command instructing the ngrok agent that started this tunnel session to exit.
- **Update Agent Ingresses**: Update attributes of an Agent Ingress by ID.
- **Update API Keys**: Update attributes of an API key by ID.
- **Update Bot Users (legacy Service Users)**: Update attributes of a bot user by ID.
- **Update Certificate Authorities**: Update attributes of a Certificate Authority by ID
- **Update Credentials**: Update attributes of an tunnel authtoken credential by ID
- **Update Endpoints**: Update an Endpoint by ID, currently available only for cloud endpoints
- **Update Event Destinations**: Update attributes of an Event Destination.
- **Update Event Sources**: Update the type for which this event subscription will trigger
- **Update Event Subscriptions**: Update an Event Subscription.
- **Update Failover Backends**: Update Failover backend by ID
- **Update HTTP Response Backends**: Update HTTP Response Backends
- **Update HTTPS Edge Routes**: Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
- **Update HTTPS Edges**: Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
- **Update IP Policies**: Update attributes of an IP policy by ID
- **Update IP Policy Rules**: Update attributes of an IP policy rule by ID
- **Update IP Restrictions**: Update attributes of an IP restriction by ID
- **Update Kubernetes Operator**: Update an existing Kubernetes Operator by ID.
- **Update Reserved Addrs**: Update the attributes of a reserved address.
- **Update Reserved Domains**: Update the attributes of a reserved domain.
- **Update Service User**: Update attributes of a Service User by ID.
- **Update SSH Certificate Authorities**: Update an SSH Certificate Authority
- **Update SSH Credentials**: Update attributes of an ssh_credential by ID
- **Update SSH Host Certificates**: Update an SSH Host Certificate
- **Update SSH User Certificates**: Update an SSH User Certificate
- **Update Static Backends**: Update static backend by ID
- **Update TCP Edges**: Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
- **Update TLS Certificates**: Update attributes of a TLS Certificate by ID
- **Update TLS Edges**: Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
- **Update Tunnel Group Backends**: Update TunnelGroup backend by ID
- **Update Tunnel Sessions**: Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Resta
- **Update Vaults**: Update an existing Vault by ID
- **Update Vault Secrets**: Update an existing Secret by ID
- **Update Weighted Backends**: Update Weighted backend by ID

Connect ngrok in General Input: https://www.generalinput.com/apps/ngrok