ngrok

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

Get the detailed status of abuse report by ID.

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.

Delete an Agent Ingress by ID

Get the details of an Agent Ingress by ID.

List all Agent Ingresses owned by this account

Update attributes of an Agent Ingress by ID.

Create a new AI Gateway API Key

Delete an AI Gateway API Key

Get an AI Gateway API Key by ID

List all AI Gateway API Keys owned by account

Update an existing AI Gateway API Key by ID

Create a new AI Gateway Provider Key

Delete an AI Gateway Provider Key

Get an AI Gateway Provider Key by ID

List AI Gateway Provider Keys

Update an existing AI Gateway Provider Key by ID

Create a new API key. The generated API key can be used to authenticate to the ngrok API.

Delete an API key by ID

Get the details of an API key by ID.

List all API keys owned by this account

Update attributes of an API key by ID.

Delete an application session by ID.

Get an application session by ID.

List all application sessions for this account.

Delete an application user by ID.

Get an application user by ID.

List all application users for this account.

Create a new bot user

Delete a bot user by ID

Get the details of a Bot User by ID.

List all bot users in this account.

Update attributes of a bot user by ID.

Upload a new Certificate Authority

Delete a Certificate Authority

Get detailed information about a certificate authority

List all Certificate Authority on this account

Update attributes of a Certificate Authority by ID

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.

Delete a tunnel authtoken credential by ID

Get detailed information about a tunnel authtoken credential

List all tunnel authtoken credentials on this account

Update attributes of an tunnel authtoken credential by ID

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Create an HTTPS Edge

Delete an HTTPS Edge by ID

Get an HTTPS Edge by ID

Returns a list of all HTTPS Edges on this account

Create an HTTPS Edge Route

Delete an HTTPS Edge Route by ID

Get an HTTPS Edge Route by ID

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.

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.

Create a TCP Edge

Delete a TCP Edge by ID

Get a TCP Edge by ID

Returns a list of all TCP Edges on this account

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.

Create a TLS Edge

Delete a TLS Edge by ID

Get a TLS Edge by ID

Returns a list of all TLS Edges on this account

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.

Create an endpoint, currently available only for cloud endpoints

Delete an Endpoint by ID, currently available only for cloud endpoints

Get the status of an endpoint by ID

List all active endpoints on the account

Update an Endpoint by ID, currently available only for cloud endpoints

Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription.

Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.

Get detailed information about an Event Destination by ID.

List all Event Destinations on this account.

Update attributes of an Event Destination.

Add an additional type for which this event subscription will trigger

Remove a type for which this event subscription will trigger

Get the details for a given type that triggers for the given event subscription

List the types for which this event subscription will trigger

Update the type for which this event subscription will trigger

Create an Event Subscription.

Delete an Event Subscription.

Get an Event Subscription by ID.

List this Account's Event Subscriptions.

Update an Event Subscription.

Create a new Failover backend

Delete a Failover backend by ID.

Get detailed information about a Failover backend by ID

List all Failover backends on this account

Update Failover backend by ID

Create

Delete

Get

List

Update

Delete

Get

Replace

Delete

Get

Replace

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.

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.

Get detailed information about an IP policy by ID.

List all IP policies on this account

Update attributes of an IP policy by ID

Create a new IP policy rule attached to an IP Policy.

Delete an IP policy rule.

Get detailed information about an IP policy rule by ID.

List all IP policy rules on this account

Update attributes of an IP policy rule by ID

Create a new IP restriction

Delete an IP restriction

Get detailed information about an IP restriction

List all IP restrictions on this account

Update attributes of an IP restriction by ID

Create a new reserved address.

Delete a reserved address.

Get the details of a reserved address.

List all reserved addresses on this account.

Update the attributes of a reserved address.

Create a new reserved domain.

Delete a reserved domain.

Detach the certificate attached to a reserved domain.

Detach the certificate management policy attached to a reserved domain.

Get the details of a reserved domain.

List all reserved domains on this account.

Update the attributes of a reserved domain.

Create a new Secret

Delete a Secret

Get a Secret by ID

List all Secrets owned by account

Update an existing Secret by ID

Create a new service user

Delete a service user by ID

Get the details of a Bot User by ID.

List all service users in this account.

Update attributes of a service user by ID.

Create a new SSH Certificate Authority

Delete an SSH Certificate Authority

Get detailed information about an SSH Certificate Authority

List all SSH Certificate Authorities on this account

Update an SSH Certificate Authority

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.

Delete an ssh_credential by ID

Get detailed information about an ssh_credential

List all ssh credentials on this account

Update attributes of an ssh_credential by ID

Create a new SSH Host Certificate

Delete an SSH Host Certificate

Get detailed information about an SSH Host Certificate

List all SSH Host Certificates issued on this account

Update an SSH Host Certificate

Create a new SSH User Certificate

Delete an SSH User Certificate

Get detailed information about an SSH User Certificate

List all SSH User Certificates issued on this account

Update an SSH User Certificate

Create a new static backend

Delete a static backend by ID.

Get detailed information about a static backend by ID

List all static backends on this account

Update static backend by ID

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Upload a new TLS certificate

Delete a TLS certificate

Get detailed information about a TLS certificate

List all TLS certificates on this account

Update attributes of a TLS Certificate by ID

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Delete

Get

Replace

Create a new TunnelGroup backend

Delete a TunnelGroup backend by ID.

Get detailed information about a TunnelGroup backend by ID

List all TunnelGroup backends on this account

Update TunnelGroup backend by ID

Get the detailed status of a tunnel session by ID

List all online tunnel sessions running on this account.

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.

Issues a command instructing the ngrok agent that started this tunnel session to exit.

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 Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted

Get the status of a tunnel by ID

List all online tunnels currently running on the account.

Create a new Vault

Delete a Vault

Get a Vault by ID

Get Secrets by Vault ID

List all Vaults owned by account

Update an existing Vault by ID

Create a new Weighted backend

Delete a Weighted backend by ID.

Get detailed information about a Weighted backend by ID

List all Weighted backends on this account

Update Weighted backend by ID