API Parameters- USERNAME: The account username
- USERID: The account User ID
- PASSWORD: The account password
- MD5PASS: The MD5 hash of the account password
- UPDATEKEY: Usage key as defined on the tunnel's Advanced tab
- IPADDRESS: Client Endpoint IPv4 address
- TUNNELID: Tunnel id #
IMPORTANT: For API calls which operate on a single tunnel, if an Update Key is set for that specific tunnel, it
must be used instead of the account password or password MD5 hash.
Many embeded systems (routers, WiFi access-points, etc.) use the historic update API, and will often MD5 the password set prior to sending the update. In this case, you will need to remove the Update Key set for the tunnel, and use your account password directly.
Tunnel Information API https://USERNAME:PASSWORD@tunnelbroker.net/tunnelInfo.php
Returns an XML structure with all of your tunnels' configuration settings. See
https://forums.he.net/index.php?topic=3109.0 for structure details.
https://USERNAME:PASSWORD@tunnelbroker.net/tunnelInfo.php?tid=TUNNELID
Returns an XML structure with this specific tunnel's configuration settings.
Tunnel Client Endpoint Update APIs NOTE: Please only trigger an update when your IP address changes!
https://ipv4.tunnelbroker.net/nic/update (Preferred) The following scripts conform to the Dyn DNS Update API (as documented at
http://dyn.com/support/developers/api/). We only support HTTPS updates.
https://USERNAME:PASSWORD@ipv4.tunnelbroker.net/nic/update?hostname=TUNNELID&myip=IPADDRESS
https://ipv4.tunnelbroker.net/nic/update?username=USERNAME&password=PASSWORD&hostname=TUNNELID&myip=IPADDRESS
Update the listed tunnel's client endpoint to the specified IP.
https://USERNAME:PASSWORD@ipv4.tunnelbroker.net/nic/update?hostname=TUNNELID
https://ipv4.tunnelbroker.net/nic/update?username=USERNAME&password=PASSWORD&hostname=TUNNELID
Update the listed tunnel's client endpoint to the IP address making the update request.
https://ipv4.tunnelbroker.net/ipv4_end.php (Deprecated)
The following scripts return either +OK or -ERROR followed by a descriptive message.
http://ipv4.tunnelbroker.net/ipv4_end.php?ip=IPADDRESS&pass=MD5PASS&user_id=USERID&tid=TUNNELID
(Not recommended)
https://ipv4.tunnelbroker.net/ipv4_end.php?ip=IPADDRESS&pass=MD5PASS&user_id=USERID&tid=TUNNELID
https://USERNAME:PASSWORD@ipv4.tunnelbroker.net/ipv4_end.php?tid=TUNNELID&ip=IPADDRESS
Update the listed tunnel's client endpoint to the specified IP.
https://USERNAME:PASSWORD@ipv4.tunnelbroker.net/ipv4_end.php?tid=TUNNELID
Update the listed tunnel's client endpoint to the IP address making the update request.