diff --git a/docs/ref/api.md b/docs/ref/api.md index 5e3677f839..cd5421d24d 100644 --- a/docs/ref/api.md +++ b/docs/ref/api.md @@ -29,12 +29,12 @@ headscale apikeys expire --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 ` 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" @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 1d08b8330b..c360bd4077 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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