Headscale API
Automate self-hosted Tailscale control-plane operations with typed clients.
Unofficial demo documentation generated with Octri. Not affiliated with or endorsed by Headscale, Tailscale, or their contributors.
Nodes
Register, inspect, rename, expire, and remove network nodes.
Users
Create and manage Headscale users and ownership.
Pre-auth keys
Provision reusable or ephemeral enrollment keys.
Quickstart
- Set your server URL
Point the client at your Headscale instance.
- Authenticate
Pass a Headscale API key as a bearer token.
- List nodes
Confirm connectivity, then explore routes, policies, users, and pre-auth keys.
SDKs in this demo: Go, TypeScript, and Python. Generated packages include typed models and tests.