Skip to content

[pull] main from juanfont:main #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pull merged 3 commits into from
Jun 19, 2026
+4 −5
Merged

[pull] main from juanfont:main #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15781ed
Fixup redirect for remote-control
nblock Jun 19, 2026
88234d4
Replace /swagger with /api/v1/docs
nblock Jun 19, 2026
d715075
TLS is not strictly required
nblock Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/ref/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ 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`
- Documentation: `/api/v1/docs`, e.g. `https://headscale.example.com/api/v1/docs`
- Headscale Version: `/version`, e.g. `https://headscale.example.com/version`
- Authenticate using HTTP Bearer authentication by sending the [API key](#api) with the HTTP `Authorization: Bearer <API_KEY>` header.

Start by [creating an API key](#api) and test it with the examples below. Read the API documentation provided by your
Headscale server at `/swagger` for details.
Headscale server at `/api/v1/docs` for details.

=== "Get details for all users"

Expand Down Expand Up @@ -66,7 +66,6 @@ The `headscale` binary can control a Headscale instance from a remote machine ov

- A workstation to run `headscale` (any supported platform, e.g. Linux).
- The Headscale server reachable over HTTP(S).
- Remote access requires an encrypted connection via TLS.
- An [API key](#api) to authenticate with the Headscale server.

### Setup remote control
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ plugins:
iOS-client.md: usage/connect/apple.md#ios
oidc.md: ref/oidc.md
ref/exit-node.md: ref/routes.md
ref/remote-cli.md: ref/api.md#grpc
remote-cli.md: ref/api.md#grpc
ref/remote-cli.md: ref/api.md#remote-control
remote-cli.md: ref/api.md#remote-control
reverse-proxy.md: ref/integration/reverse-proxy.md
tls.md: ref/tls.md
web-ui.md: ref/integration/web-ui.md
Expand Down
Loading