Your AI team, working in Ngrok

Ngrok creates secure tunnels to locally hosted applications, enabling developers to share and test webhooks or services without configuring complex network settings

Start your company

What your team can do in Ngrok

102 tools to work with, connected with an API key.

Create API Key

Creates a new API key for authenticating with the ngrok API. This tool allows programmatic creation of API keys that can be used to access ngrok's API services.

Create Endpoint

Create a cloud endpoint on the ngrok account. Use when you need to set up a new cloud endpoint with custom traffic policies for handling HTTP traffic.

Create Event Source

Add a new event source to an event subscription. Event sources define which types of events will trigger the subscription. Use this when you need to subscribe to additional event types for an existing event subscription.

Create Event Subscription

Creates a new event subscription in ngrok. Event subscriptions allow you to be notified when specific events occur in your ngrok account. Use this when you need to set up webhooks or event-driven workflows for ngrok resource changes.

Create HTTPS Edge

Creates a new HTTPS edge in your ngrok account. HTTPS edges define how ngrok handles HTTPS traffic for your domains. Use this when you need to set up a new HTTPS endpoint with custom TLS or mutual TLS configuration.

Create HTTPS Edge Route

Creates a new route on an HTTPS edge in ngrok. Routes define how traffic matching specific patterns should be handled and can include various security and transformation modules. Use when you need to configure routing rules for an HTTPS edge with optional modules like OAuth, IP restrictions, header transformations, and more.

Create SSH Credential

Creates 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. Use when you need to authenticate SSH-based tunnel connections with ngrok.

Create Tunnel Credential

Creates a new tunnel authtoken credential for authenticating ngrok agents. 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.

Create Vault

Creates a new vault in your ngrok account. Vaults are used for securely storing and managing sensitive data such as secrets, credentials, and tokens.

Create Vault Secret

Tool to create a new secret in an ngrok vault for secure storage of sensitive data like API keys, passwords, or tokens. Use when you need to securely store sensitive information that can be referenced in traffic policies without exposing the actual values.

Delete API Key

Delete an API key by its ID. This action permanently removes the specified API key from your ngrok account. This is an important security feature that allows users to revoke access when an API key is compromised or no longer needed. Once deleted, the API key cannot be recovered and any services using it will lose access.

Delete Credentials

Delete a tunnel authtoken credential by ID. This action permanently removes the specified credential from your ngrok account.

Delete Edge Route Compression Module

Delete the compression module from an HTTPS edge route. Use this to remove compression settings from a specific route within an HTTPS edge configuration.

Delete Edge Route Request Headers Module

Delete the request headers module from an HTTPS edge route. This removes any custom request header modifications configured for the specified route. Use this action when you need to stop modifying request headers on a specific edge route. After deletion, requests will pass through without header modifications.

Delete Edge Route Response Headers Module

Delete the response headers module from an HTTPS edge route. Use when you need to remove response header manipulation from a specific route.

Delete Edge Route SAML Module

Delete the SAML module configuration from an HTTPS edge route. This action removes SAML authentication from the specified route, allowing traffic to pass through without SAML validation. The operation is idempotent and returns success even if no SAML module exists.

Delete Edge Route User Agent Filter Module

Delete the user agent filter module from an HTTPS edge route. Use this to remove user agent filtering from a specific route within an HTTPS edge configuration.

Delete Edge Route Webhook Verification Module

Delete the webhook verification module from an HTTPS edge route. This removes webhook signature verification configured for the specified route. Use this action when you need to stop verifying webhook signatures on a specific edge route. After deletion, webhooks will pass through without signature verification.

Delete Edge Route WebSocket TCP Converter Module

Delete the WebSocket TCP converter module from an HTTPS edge route. Use when you need to remove WebSocket to TCP conversion functionality from a specific route. The operation is idempotent.

Delete Endpoint

Delete an endpoint by ID. This action permanently removes the specified endpoint from your ngrok account. Currently only available for cloud endpoints. Cloud endpoints are those created through the ngrok dashboard or API with reserved domains. Once deleted, the endpoint cannot be recovered and traffic to the endpoint will no longer be processed.

Delete Event Source

Delete an event source from an event subscription. This removes a specific event type from the subscription, so the subscription will no longer trigger for that event. Event sources define which types of events trigger notifications for a subscription. Removing an event source does not delete the subscription itself - only the association with that specific event type.

Delete Event Subscription

Delete an event subscription by ID. This action permanently removes the specified event subscription from your ngrok account. Event subscriptions allow you to receive notifications when specific events occur in your ngrok account. Once deleted, you will no longer receive notifications for events matching this subscription.

Delete HTTPS Edge

Delete an HTTPS edge by ID. This action permanently removes the specified HTTPS edge configuration from your ngrok account. HTTPS edges define how ngrok handles HTTPS traffic for your domains. Once deleted, the edge and all associated routes cannot be recovered, and traffic to the configured hostports will no longer be processed.

Delete HTTPS Edge Route

Delete an HTTPS edge route by ID. This action permanently removes the specified route from an HTTPS edge configuration in your ngrok account. HTTPS edge routes define how traffic is handled for specific hostnames and paths. Once deleted, the route cannot be recovered and traffic matching the route will no longer be processed.

Delete HTTPS Edge Route Circuit Breaker Module

Delete the Circuit Breaker module from an HTTPS Edge Route. This action removes the circuit breaker configuration that protects upstream services from being overwhelmed by automatically rejecting requests when error thresholds are exceeded.

Delete Reserved Domain Certificate

Detach the certificate attached to a reserved domain. Use when you need to remove a certificate from a reserved domain without deleting the domain itself.

Delete Reserved Domain Certificate Management Policy

Detach the certificate management policy from a reserved domain. Use this action when you need to remove certificate management configuration from a domain.

Delete Secret

Delete a vault secret by ID. This action permanently removes the specified secret from your ngrok vault.

Delete SSH Credentials

Delete an SSH credential by ID. This action permanently removes the specified SSH credential from your ngrok account. SSH credentials are used to authenticate SSH connections through ngrok. Once deleted, the credential cannot be recovered and any services using it will lose access.

Delete Vault

Delete a vault by ID. This action permanently removes the specified vault from your ngrok account.

Get API KeyReads only

Get the details of an API key by ID. Use this tool to retrieve information about a specific ngrok API key, including its description, metadata, and creation timestamp.

Get CredentialsReads only

Tool to retrieve detailed information about a tunnel authtoken credential by ID. Use when you need to view the details, metadata, or ACL rules of an existing credential. Note: The token field will be null for existing credentials (only available on creation).

Get Edge Route Backend ModuleReads only

Retrieves the backend module configuration for an HTTPS edge route. Backend modules define where traffic is routed after passing through the edge route's modules. Use this to verify backend configuration or audit routing behavior.

Get Edge Route Circuit Breaker ModuleReads only

Tool to retrieve the circuit breaker module configuration for a specific HTTPS edge route. Use when you need to check the current circuit breaker settings, verify protection parameters, or audit traffic protection policies.

Get Edge Route Compression ModuleReads only

Retrieves the compression module configuration for a specific HTTPS edge route. Use this to check if compression is enabled for the route.

Get Edge Route IP Restriction ModuleReads only

Retrieves the IP restriction module configuration for a specific HTTPS edge route. Use this to check which IP policies are applied to control access to the route.

Get Edge Route OIDC ModuleReads only

Retrieves the OIDC (OpenID Connect) module configuration for a specific HTTPS edge route, including provider settings, scopes, and session timeouts. If the API returns null, the tool returns an object with null configuration fields.

Get Edge Route Request Headers ModuleReads only

Retrieves the request headers module configuration for a specific HTTPS edge route. The request headers module allows you to add and remove headers from HTTP requests before they are sent to your upstream server. Use this action to inspect the current request header manipulation rules for a route.

Get Edge Route Response Headers ModuleReads only

Get the response headers module configuration for an HTTPS edge route. Use when you need to retrieve the current response header manipulation settings for a specific route.

Get Edge Route SAML ModuleReads only

Retrieves the SAML authentication module configuration for a specific HTTPS edge route. Use this to view SAML settings including identity provider configuration, session timeouts, and authorized groups.

Get Edge Route Traffic PolicyReads only

Retrieves the Traffic Policy module configuration for a specific HTTPS edge route. Traffic policies define how ngrok handles requests and responses on the edge route. Use this to inspect current traffic policy rules applied to an edge route.

Get Edge Route User Agent Filter ModuleReads only

Retrieves the user agent filter module configuration for a specific HTTPS edge route. Use this to view filtering rules that control access based on User-Agent headers.

Get Edge Route Webhook Verification ModuleReads only

Retrieves the webhook verification module configuration for an HTTPS edge route. Webhook verification modules validate incoming webhooks from supported providers. Use this to verify webhook configuration or audit webhook security settings.

Get Edge Route WebSocket TCP Converter ModuleReads only

Retrieve the WebSocket TCP Converter module configuration for a specific HTTPS edge route. The module converts WebSocket connections to TCP streams; a null API response is returned as disabled.

Get EndpointReads only

Get the status of an endpoint by ID. Use this tool to retrieve detailed information about a specific ngrok endpoint, including its configuration, URLs, and associated resources.

Get Event SourceReads only

Get an event source by type for a specific event subscription. Use this tool to retrieve details about a specific event source type that triggers notifications for an event subscription.

Get HTTPS EdgeReads only

Get the details of an HTTPS edge by ID. Use this to retrieve information about a specific HTTPS edge configuration including its hostports, TLS settings, and routes.

Get HTTPS Edge Mutual TLS ModuleReads only

Retrieves the mutual TLS module configuration for an HTTPS edge. Use this to check if mutual TLS is enabled and which certificate authorities are configured for client certificate validation.

Get HTTPS Edge RouteReads only

Retrieves detailed information about a specific HTTPS edge route by its ID. HTTPS edge routes define how ngrok routes traffic based on path matching rules and apply various modules like authentication, compression, and traffic policies.

Get IP Restriction DetailsReads only

Retrieves detailed information about a specific IP restriction by its ID. IP restrictions control which IP addresses can access various ngrok resources (dashboard, API, agents, or endpoints). This action fetches complete details including enforcement status, associated IP policies, and metadata. Use this action for auditing, verification, or before modifying IP restrictions. Note: Requires Account Governance add-on on a Pay-as-you-go plan to have IP restrictions.

Get Reserved DomainReads only

Get the details of a reserved domain by ID. Use this to retrieve information about a specific reserved domain including its hostname, certificate configuration, and DNS settings.

Get SecretReads only

Tool to retrieve detailed information about a vault secret by ID. Use when you need to view the metadata, description, or vault information for an existing secret.

Get Secrets by VaultReads only

Tool to get all secrets in a vault by vault ID. Use this to retrieve the list of secrets stored in a specific ngrok vault. Supports pagination for large result sets.

Get SSH CredentialsReads only

Tool to retrieve detailed information about an SSH credential by ID. Use when you need to view the details, public key, metadata, or ACL rules of an existing SSH credential.

Get VaultReads only

Get the details of a vault by ID. Use this tool to retrieve information about a specific ngrok vault, including its name, description, metadata, and timestamps.

List Active TunnelsReads only

List all active tunnels in the ngrok account. This tool lists all active tunnels in the ngrok account, providing details such as tunnel ID, public URL, start time, protocol, configuration details, and metadata. It requires no input parameters beyond authentication and returns a paginated list of all running tunnels with their complete status information.

List Agent IngressesReads only

List Agent Ingresses owned by the account, with pagination and optional filtering. Agent Ingresses configure custom domains for ngrok agent connections.

List All EndpointsReads only

List active endpoints on the ngrok account, with optional filtering and pagination. Returns one page and a next-page URI when available.

List API KeysReads only

This tool lists all API keys owned by the user. The API keys are used to authenticate API requests to ngrok's REST API. The endpoint returns a paginated list of API keys.

List Bot UsersReads only

List bot users on the ngrok account, including their status, with pagination.

List Certificate AuthoritiesReads only

List certificate authorities on the account, with pagination and filtering via CEL expressions. Certificate authorities are x509 certificates used to sign other x509 certificates.

List Event DestinationsReads only

List a page of event destinations on the ngrok account, with optional filtering and pagination. Event destinations define where and how ngrok sends event data, such as to AWS, Datadog, or Azure.

List Event Subscription SourcesReads only

Tool to list the types for which this event subscription will trigger. Use when you need to see all event sources configured for a specific event subscription.

List Event SubscriptionsReads only

List a page of event subscriptions on the ngrok account, with optional filtering and pagination. Event subscriptions allow notifications when specified account events occur.

List Failover BackendsReads only

List a page of failover backends on the account, with pagination support. Failover backends reference an ordered list of backends, trying the next backend when the first is offline.

List HTTP Response BackendsReads only

List all HTTP response backends on the account. Use this to retrieve all configured static HTTP response backends that return fixed responses with specific status codes.

List HTTPS EdgesReads only

Lists all HTTPS Edges in your ngrok account. HTTPS edges are configurations that tell ngrok how to handle HTTPS traffic. The action returns a paginated list of all HTTPS edges associated with your account.

List IP PoliciesReads only

List all IP policies on this account. IP policies are reusable groups of CIDR ranges with an allow or deny action that can be attached to endpoints via the Endpoint Configuration IP Policy module. Supports pagination and filtering with CEL expressions.

List IP Policy RulesReads only

This tool lists all IP policy rules associated with your ngrok account. It retrieves detailed information including rule id, creation timestamp, description, metadata, CIDR, the associated IP policy, and the action (allow or deny) for each rule. It supports pagination with parameters 'limit' for the maximum number of results and 'before_id' for pagination.

List IP RestrictionsReads only

Lists all IP restrictions configured on the ngrok account. IP restrictions control which source CIDR blocks are permitted to access specific ngrok account features such as the dashboard, API, agents, or public endpoints. Supports pagination via 'limit' and 'before_id', and filtering via CEL expressions. Returns details including id, uri, created_at, description, metadata, enforced status, type, and associated IP policies for each restriction.

List Reserved AddressesReads only

List reserved TCP addresses on the ngrok account, with pagination and optional filtering.

List Reserved DomainsReads only

List reserved domains on the ngrok account, with pagination and optional filtering. These include hostnames reserved for HTTP, HTTPS, and TLS traffic.

List Service UsersReads only

List service users on the ngrok account with their active status. Supports pagination and filtering.

List SSH Certificate AuthoritiesReads only

List all SSH Certificate Authorities on this account. SSH Certificate Authorities are pairs of SSH certificates and their private keys used to sign other SSH host and user certificates. Supports pagination and filtering via CEL expressions.

List SSH CredentialsReads only

List all SSH credentials on the ngrok account. Use when you need to view all SSH public keys that can authenticate to start SSH tunnels.

List SSH Host CertificatesReads only

List all SSH Host Certificates issued on this account. SSH Host Certificates are used to sign SSH host keys and authenticate SSH servers. Supports pagination for efficient retrieval of large result sets.

List SSH User CertificatesReads only

List all SSH user certificates on the ngrok account. Use when you need to view all SSH certificates that authenticate SSH clients to SSH servers.

List Static BackendsReads only

List all static backends on the account. Static backends forward traffic to TCP addresses (hostname and port) that are reachable on the public internet.

List TCP EdgesReads only

Lists all TCP Edges in your ngrok account. TCP edges are configurations that tell ngrok how to handle TCP traffic. The action returns a paginated list of all TCP edges associated with your account.

List TLS CertificatesReads only

List all TLS certificates on the ngrok account. Use when you need to retrieve information about uploaded TLS certificates including validity, domains, and metadata.

List TLS EdgesReads only

Lists all TLS Edges in your ngrok account. TLS edges are configurations that tell ngrok how to handle TLS traffic. The action returns a paginated list of all TLS edges associated with your account.

List Tunnel CredentialsReads only

List tunnel authtoken credentials on the ngrok account, with pagination and optional filtering. These credentials can authenticate ngrok agents and start tunnel sessions.

List Tunnel SessionsReads only

List all online tunnel sessions running on this account. Tunnel sessions represent instances of ngrok agents or SSH reverse tunnel sessions connected to the ngrok service. Each tunnel session can include one or more tunnels.

List Vault SecretsReads only

List a page of vault secrets owned by the ngrok account, with optional filtering and pagination. Results contain secret details for traffic policy configurations, not secret values.

List VaultsReads only

List a page of vaults owned by the ngrok account, with optional filtering and pagination. Vaults are used for securely storing and managing sensitive data such as secrets, credentials, and tokens.

List Weighted BackendsReads only

List a page of weighted backends on the ngrok account. Weighted backends balance traffic among referenced backends proportionally based on their assigned weights.

Replace Edge Route Circuit Breaker Module

Replaces the circuit breaker module configuration on an HTTPS edge route. Circuit breakers protect upstream applications by rejecting traffic when error rates exceed thresholds, giving systems time to recover. Use this action when you need to configure or update circuit breaker settings for a specific route on an HTTPS edge.

Replace Edge Route Compression Module

Replaces the compression module configuration for an HTTPS edge route. Use this when you need to enable or disable automatic HTTP response compression for a specific route.

Replace Edge Route Request Headers Module

Replaces the request headers module configuration for an HTTPS edge route. Use this to modify HTTP request headers before they are sent to your upstream application server. You can add new headers or remove existing ones.

Replace Edge Route Response Headers Module

Replaces the response headers module configuration for an HTTPS edge route. Use this to control which HTTP headers are added to or removed from responses sent to clients. This allows customization of response headers for security, CORS, caching, or other purposes.

Replace Edge Route Traffic Policy

Replaces the traffic policy module on an HTTPS edge route. Traffic policies allow you to control and modify HTTP traffic flowing through your ngrok endpoints. Use this action when you need to update or change the traffic policy rules for a specific route on an HTTPS edge.

Replace Edge Route User Agent Filter Module

Replaces the user agent filter module configuration for an HTTPS edge route. Use this to control which User-Agent strings are allowed or denied access to your route based on regex patterns. Denied patterns take precedence over allowed patterns.

Replace Edge Route Webhook Verification Module

Replaces the webhook verification module configuration for an HTTPS edge route. Configure ngrok to verify webhook signatures from supported providers, or disable the module.

Update API Key

Updates attributes of an API key by ID. Use this to modify the description or metadata of an existing API key without changing its token or credentials.

Update Credentials

Tool to update attributes of a tunnel authtoken credential by ID. Use when you need to modify the description, metadata, or ACL rules of an existing credential.

Update Endpoint

Tool to update an Endpoint by ID, currently available only for cloud endpoints. Use this to modify the description, metadata, traffic policy, bindings, or other attributes of an existing endpoint.

Update Event Subscription

Tool to update attributes of an event subscription by ID. Use when you need to modify the description, metadata, destination IDs, or sources of an existing event subscription.

Update HTTPS Edge Route

Tool to update an HTTPS edge route by ID. Use when you need to modify route configuration for HTTPS traffic handling. Updates can include match patterns, module settings, and metadata. Unspecified modules remain unchanged.

Update Reserved Domain

Tool to update the attributes of a reserved domain by ID. Use this to modify the description, metadata, certificate configuration, or DNS resolver targets of an existing reserved domain.

Update Secret

Tool to update a vault secret by ID. Use when you need to modify the name, description, metadata, or value of an existing secret in the ngrok vault.

Update SSH Credential

Tool to update attributes of an SSH credential by ID. Use when you need to modify the description, metadata, or ACL rules of an existing SSH credential.

Update Vault

Tool to update attributes of a vault by ID. Use when you need to modify the name, description, or metadata of an existing vault.

More in Developer tools

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or