Get - ngrok documentation

Get - ngrok documentation

Bearer authentication header of the form Bearer <token> , where <token> is your auth token.

a resource identifier

Get the detailed status of a tunnel session by ID

version of the ngrok agent that started this ngrok tunnel session

reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session

Show child attributes

unique tunnel session resource identifier

source ip address of the tunnel session

arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option

operating system of the host the ngrok agent is running on

the ngrok region identifier in which this tunnel session was started

time when the tunnel session first connected to the ngrok servers

the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh

URI to the API resource of the tunnel session

Was this page helpful?