What are Domains?
Domains enable you to create public endpoints with hostnames matching the domain. For example, after you create the domain your-name.ngrok.app
, you may create the Endpoint https://your-name.ngrok.app
.
Valid Domain names include:
- ngrok-managed domains, like
foo.ngrok.app
. - Your own custom domains, like
example.your-domain.com
, by creating aCNAME
DNS record with your domain's DNS provider.
Configuration
Domains also enable you to configure other domain-level behaviors, including:
- Global Load Balancer configuration - Choose which points of presence handle traffic to a Domain's matching endpoints.
Coming Soon
Per-region global load balancer configuration is coming soon, request access to the developer preview.
- TLS Certificate management - Configure automatic certificate provisioning or select a certificate you uploaded yourself.
- Dedicated IP address configuration - Attach static, dedicated IPs for a Domain's matching endpoints receive traffic on.
You can manage Domains on your ngrok Dashboard or via the ngrok API.
Wildcard domains
You may create a Domain with a wildcard name, e.g. *.example.com
. A wildcard domain enables you to:
- Create an endpoint which receives traffic for all of its subdomains, e.g.
https://*.example.com
. See Wildcard Endpoints to understand the rules for matching and precedence. - Create an endpoint on any subdomain which matches the wildcard, e.g.
https://foo.example.com
orhttps://foo.bar.baz.example.com
The wildcard *
character may only be used as the first part of a
domain, you may not create domains like app.*.example.com
or
*-app.example.com
.
Ownership
Your account exclusively owns its Domains and all of their nested subdomains within ngrok. That means:
- No account may create a Domain with a name that is a subdomain of your Domains.
- No other account may create endpoints with a hostname matching your Domain or any of its nested subdomains.
For example, if you create a Domain with the name foo.ngrok.app
:
- No other account create the Domains
foo.ngrok.app
orbar.foo.ngrok.app
. - No other account may create the endpoints
https://foo.ngrok.app
orhttps://bar.foo.ngrok.app
.
API
Domains are programatically managed via:
Pricing
Domains are available on all plans. Some Domain features require upgrades. See the Pricing page for details.
Feature | Plans |
---|---|
Domains | All plans. The Domain name is assigned on Free, you may choose it on other plans. |
Bring-your-own domains | Personal, Pro, Enterprise, Pay-as-you-go |
Wildcard Domains | Enterprise |