Mirrors/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-07-17 16:36:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Replace /swagger with /api/v1/docs

Browse source
This commit is contained in:
Florian Preinstorfer 2026-06-19 17:22:02 +02:00 • committed by nblock
parent 15781ed6d8
commit 88234d4046
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/ref/api.md
View file

@ -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"