Endpoints have a type, which can be eitherDocumentation Index
Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
agent or cloud.
Cloud Endpoints versus Agent Endpoints
In general, Cloud Endpoints are the most flexible option, but which endpoint type you should choose depends on your use-case. The following table outlines the differences between Cloud and Agent endpoints.| Cloud Endpoints | Agent Endpoints | |
|---|---|---|
| Lifetime | Always-on. Must be manually terminated. | Live as long as the agent process that started them. |
| Connection Handling | Can be configured with Traffic Policy. | Can be configured with Traffic Policy. |
| Configuration | Can be managed at any time via the API or dashboard. | Managed by the agent that initiates them. |
| Dashboard accessibility | Can be created and configured from the dashboard. | Read-only in the dashboard. |
| Can use ephemeral domains? | No. Must be provided a fully qualified URL on creation. | Yes. ngrok can generate a URL for you on creation. |
| Traffic Policy required? | Yes. | No, but you can provide one if you’d like. |
| Globally available | Yes. | Yes. |
| Can be managed with the API? | Yes. | Yes, with the agent api. |
| Pricing options | Available on paid plans. | Available on all plans. |
Protocols, binding and pooling
Both Agent and Cloud Endpoints support:-
All Endpoint Protocols
http/httpstcptls
-
All Endpoint Bindings
publicinternalkubernetes
- Endpoint Pooling. You can also pool Agent Endpoints with Cloud Endpoints.
Get started
- See the Cloud Endpoints Quickstart.
- See the ngrok Getting Started guide to set up an Agent Endpoint.