ngrok

API Commands

Use the ngrok API and agent API to programmatically create tunnels and manage endpoints.

9 commands

Pro Tips

Use the local API at localhost:4040/api for automation

Commands

List tunnels (API)

$ curl http://localhost:4040/api/tunnels

Get active tunnels via local API.

Get public URL

$ curl -s http://localhost:4040/api/tunnels | jq '.tunnels[0].public_url'

Extract public URL from API.

Stop tunnel (API)

$ curl -X DELETE http://localhost:4040/api/tunnels/command_line

Stop a tunnel via API.

Check version

$ ngrok version

Show ngrok version.

List endpoints

$ ngrok api endpoints list

List all active endpoints via ngrok API.

List reserved domains

$ ngrok api reserved-domains list

List all reserved domains on your account.

Replay captured request

$ curl -X POST http://localhost:4040/api/requests/http/req_abc123/replay

Replay a captured request from the inspector.

Update ngrok

$ ngrok update

Update ngrok to the latest version.

List edge routes

$ ngrok api edges https list

List all HTTPS edges configured in your account.