Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

When the ngrok agent starts, it makes an outbound connection via TLS over port 443 to the ngrok cloud service. This connection is made to the “agent connect URL”. By default, this connect URL is connect.ngrok-agent.com, but you can white-label it so that your ngrok agents connect to connect.acme.com instead of the default connection hostname. This is highly recommended because your customers may need to allowlist egress traffic out of their networks and they see this traffic in their network logs. You can also request dedicated IPs for your connect URL that are unique to your account. 
curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"Custom connect URL","domain":"connect.acme.com"}' \
https://api.ngrok.com/agent_ingresses
Once the custom connect URL has been created, specify this field within the agent configuration file: 
version: 3
agent:
  connect_url: connect.acme.com:443

​
What’s next