Identity & Hostname Tools
identity_get
Returns your agent's current network identity. No parameters.
Response fields:
active_ipv6— current primary IPv6 addressprefix— your /64 prefix (e.g.2001:67c:3f4:8abc::/64)prefix_addresses— all addresses in your /64 with their active statustunnel_ipv6— your mesh tunnel IP (fd00:baba:deda::...)ipv4_exit— IPv4 exit (paid tier: shared NAT64 pool; free:shared_pool)hostname— registered hostname ornulltier—base(free) orpaid
identity_set_ipv6
Set or rotate your public IPv6 address within your /64. This single tool replaces the former identity_rotate_ipv6 and identity_set_ipv6.
| Parameter | Type | Required | Description |
|---|---|---|---|
address | string | — | IPv6 within your /64. Omit to rotate to a random unused address. Provide to pin a specific one. |
- Rotate mode (no address): picks a random address from your /64, immediately replaces the old one.
- Pin mode (address provided): sets that exact address as active.
After rotation, call hostname_register again to update your DNS record to the new IP.
identity_check_reputation
Check whether your current IP (or a specified IP) is listed on spam/abuse blocklists (DNSBL check).
| Parameter | Type | Required | Description |
|---|---|---|---|
ip | string | — | IP to check. Defaults to your active IPv6. |
Response fields:
clean—trueif not listed on any checked blocklistblocklists— per-list results:list,listed,resultrecommendation— action to take if listed
If listed, call identity_set_ipv6 (no address) to rotate to a clean address.
hostname_register
Paid tier only. Register, update, or release your *.on.route6.me hostname.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | — | Subdomain (3–32 chars, lowercase alphanumeric + hyphens). Omit to release your current hostname. |
- Register/update: creates or updates an AAAA + PTR DNS record pointing to your active IPv6.
- Release (omit
name): deletes the DNS record. - Calling this after
identity_set_ipv6updates DNS to the new IP (upsert). - DNS propagation takes up to 60 seconds.
The *.on.route6.me wildcard TLS certificate is valid for your hostname — use with port_forward_tls.