Version: 1
njMule remote-control API
Every call needs the API token of the njMule it reaches, sent as Authorization: Bearer <token>.
The token is kept in the api-token file of njMule's configuration directory; njmule --api-token
prints it and njmule --new-api-token replaces it. Wrong tokens count as failed logins of the
caller's address, which must wait a minute after five of them.
Enum values are lower case. Hashes are the 32 hexadecimal digits of an MD4 file or user hash.
Errors answer with an Error object whose message is meant for the caller.
Authentication
- HTTP: Bearer Auth
The API token of the njMule, from the api-token file of its configuration directory.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | 43 characters of URL-safe Base64 (256 random bits) |