API Keys
API keys are prefixed with hlk_ and are issued from the Hoplynk dashboard. Pass your key in the X-API-Key header on every request.
curl https://argus.hoplynk.com/api/kits \
-H "X-API-Key: hlk_..."
API keys are shown only once at creation. Store them securely — treat them like passwords.
Getting a Key
Log into the Hoplynk dashboard and generate an API key from the API Keys section. Keys are issued per account and scoped to your kits.
Key Scopes
All partner API keys have the following scopes by default:
| Scope | Access |
|---|
telemetry:read | Read kit location, links, and telemetry |
assets:read | Read assets and their feeds |
Environment Variables
We recommend storing your API key and kit ID as environment variables:
export HOPLYNK_API_KEY=hlk_...
export HOPLYNK_KIT_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
