headscale/docs/ref/api.md

API

Headscale provides a HTTP REST API and a gRPC interface which may be used to integrate a web interface, remote control Headscale or provide a base for custom integration and tooling.

Both interfaces require a valid API key before use. To create an API key, log into your Headscale server and generate one with the default expiration of 90 days:

headscale apikeys create

Copy the output of the command and save it for later. Please note that you can not retrieve an API key again. If the API key is lost, expire the old one, and create a new one.

To list the API keys currently associated with the server:

headscale apikeys list

and to expire an API key:

headscale apikeys expire --prefix <PREFIX>

REST API

• API endpoint: /api/v1, e.g. https://headscale.example.com/api/v1
• Documentation: /swagger, e.g. https://headscale.example.com/swagger
• Authenticate using HTTP Bearer authentication by sending the API key with the HTTP Authorization: Bearer <API_KEY> header.

Start by creating an API key and test it with the examples below. Read the API documentation provided by your Headscale server at /swagger for details.

=== "Get details for all users"

```console
curl -H "Authorization: Bearer <API_KEY>" \
    https://headscale.example.com/api/v1/user
```

=== "Get details for user 'bob'"

```console
curl -H "Authorization: Bearer <API_KEY>" \
    https://headscale.example.com/api/v1/user?name=bob
```

=== "Register a node"

```console
curl -H "Authorization: Bearer <API_KEY>" \
    -d user=<USER> -d key=<KEY> \
    https://headscale.example.com/api/v1/node/register
```

gRPC

The gRPC interface can be used to control a Headscale instance from a remote machine with the headscale binary.

Prerequisite

• A workstation to run headscale (any supported platform, e.g. Linux).
• A Headscale server with gRPC enabled.
• Connections to the gRPC port (default: 50443) are allowed.
• Remote access requires an encrypted connection via TLS.
• An API key to authenticate with the Headscale server.

Setup remote control

1. Download the headscale binary from GitHub's release page. Make sure to use the same version as on the server.

2. Put the binary somewhere in your PATH, e.g. /usr/local/bin/headscale

3. Make headscale executable: chmod +x /usr/local/bin/headscale

4. Create an API key on the Headscale server.

5. Provide the connection parameters for the remote Headscale server either via a minimal YAML configuration file or via environment variables:

   === "Minimal YAML configuration file"

   ```yaml title="config.yaml"
   cli:
       address: <HEADSCALE_ADDRESS>:<PORT>
       api_key: <API_KEY>
   ```
   

   === "Environment variables"

   ```shell
   export HEADSCALE_CLI_ADDRESS="<HEADSCALE_ADDRESS>:<PORT>"
   export HEADSCALE_CLI_API_KEY="<API_KEY>"
   ```
   

   This instructs the headscale binary to connect to a remote instance at <HEADSCALE_ADDRESS>:<PORT>, instead of connecting to the local instance.

6. Test the connection by listing all nodes:

   headscale nodes list
   

   You should now be able to see a list of your nodes from your workstation, and you can now control the Headscale server from your workstation.

Behind a proxy

It's possible to run the gRPC remote endpoint behind a reverse proxy, like Nginx, and have it run on the same port as Headscale.

While this is not a supported feature, an example on how this can be set up on NixOS is shown here.

Troubleshooting

• Make sure you have the same Headscale version on your server and workstation.
• Ensure that connections to the gRPC port are allowed.
• Verify that your TLS certificate is valid and trusted.
• If you don't have access to a trusted certificate (e.g. from Let's Encrypt), either:
  • Add your self-signed certificate to the trust store of your OS or
  • Disable certificate verification by either setting cli.insecure: true in the configuration file or by setting HEADSCALE_CLI_INSECURE=1 via an environment variable. We do not recommend to disable certificate validation.