Command for adding API KEY to ngrok.yml file doesn't work

Question

This command ngrok config add-authtoken <API KEY> on the documentation doesn't work for me. If you are having a hard time looking for a solution try this code ngrok authtoken <YOUR API KEY> and it will add your ngrok API KEY to the config file which is ngrok.yml in ~/.ngrok2/ngrok.yml

Note: This helped on a windows machine

score 0 · Accepted Answer · answered Jun 02 '22 at 12:37

0

The reason for this is that, unfortunately, ngrok doesn't version its docs. If you installed ngrok through pyngrok, you installed v2, but ngrok's site now hosts v3 docs, as it came out recently. The v2 command to install your auth token is:

ngrok authtoken <YOUR API KEY>

You can peruse the v2 docs here.

answered Jun 02 '22 at 12:37

alexdlaird

1,174
12
34

Okay, thanks a lot I now understand. But does it have to be the version 2 you always get when you install `ngrok` through `pyngrok` ? – Joshua Nyarko Boateng Jun 03 '22 at 14:14
Until it’s updated to support v3, yes. There are breaking changes between the two versions. – alexdlaird Jun 04 '22 at 15:13

Command for adding API KEY to ngrok.yml file doesn't work

1 Answers1