Skip to main content

​
API key

ntrp uses Bearer token authentication. Include the key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY

​
Getting a key

An API key is generated on first ntrp-server serve: 
cd apps/server
uv run ntrp-server serve
# Your API key: nBx7k2...
# Enter this in the desktop client to connect. It won't be shown again.

​
Resetting a key

cd apps/server
uv run ntrp-server serve --reset-key
This invalidates the old key immediately.

​
Storage

The server stores only a salted SHA-256 hash of the key — the plaintext is never persisted. Desktop clients store the plaintext locally and encrypt it with OS-backed storage when supported.

​
Public endpoints

The /health endpoint is always public (no auth required). This allows Docker healthchecks and monitoring tools to work without credentials.