API Reference

REST API v1.1

All endpoints accept and return JSON. Errors return a stable code field — see the error reference.

Initialize

POST/api/v1.1/init

Opens a session for your application using the owner ID and app secret.

Request body
FieldTypeDescription
owner_idstringYour Atheryx owner ID.
app_namestringThe application name from your dashboard.
versionstringClient version string.
secretstringApplication secret (App Settings → Secrets).
hashstring (opt)Client build hash for tamper checks.
hwidstring (opt)Hardware ID to bind to the session.
Sessions expire after 7 days of active use or 72 hours of inactivity.

Login

POST/api/v1.1/login

Authenticates a user with credentials. Password verified with bcrypt.

Request body
FieldTypeDescription
session_idstringSession token from /init.
usernamestringAccount username.
passwordstringAccount password (never stored in plaintext).
hwidstring (opt)Hardware ID; must match the account's bound HWID if one exists.
ipstring (opt)Client IP for audit logging.
Returns a short-lived token plus the user's roles, tags, and licenses.

Register

POST/api/v1.1/register

Registers a new user against an existing, unused license key.

Request body
FieldTypeDescription
session_idstringSession token from /init.
usernamestringDesired username (must be unique).
passwordstringDesired password, hashed with bcrypt (cost 12).
keystringA valid, unused license key for this app.
emailstring (opt)User email.
hwidstring (opt)Hardware ID to bind at registration.
The license key is marked as used and bound to the new user.

Validate License

POST/api/v1.1/licenses

Activates or validates a license key and binds the caller's HWID.

Request body
FieldTypeDescription
session_idstringSession token from /init.
license_keystringThe license key to validate.
hwidstring (opt)Hardware ID; must match the license's bound HWID if set.
ipstring (opt)Client IP for audit logging.
Expired licenses are marked EXPIRED; returning clients get LIC_EXPIRED until renewed.

Refresh Session

POST/api/v1.1/session/refresh

Rotates the session token using a refresh token, extending active life.

Request body
FieldTypeDescription
session_idstringCurrent session token.
refresh_tokenstringRefresh token issued at login/init.
Use this to keep long-running clients alive past inactivity limits.

Read Variable

POST/api/v1.1/variables

Fetches a server-side variable by key for feature flags or remote config.

Request body
FieldTypeDescription
session_idstringSession token from /init.
var_keystringVariable key to read.
The value is not returned in plaintext — the response carries an AES-256-CBC envelope you decrypt with the session enckey from /init.

Set Variable

POST/api/v1.1/variables/set

Writes a server-side variable value (e.g. remote config updates).

Request body
FieldTypeDescription
session_idstringSession token from /init.
encryptedstringbase64(iv ‖ AES-256-CBC(payload)).
hmacstringHMAC-SHA256 of the ciphertext, hex, first 32 characters.
Plaintext writes are rejected. The encrypted payload must carry session_id, var_key and var_value, signed with SHA-256(enckey).

Report Logs

POST/api/v1.1/logs

Sends client-side log events to your application's activity feed.

Request body
FieldTypeDescription
session_idstringSession token from /init.
messagestringLog line to record.
Sanitized server-side; check the dashboard under App → Logs.

Claim Password

POST/api/v1.1/claim-password

Sets the password on a reseller or free-issued account that still carries a one-time setup code.

Request body
FieldTypeDescription
session_idstringSession token from /init.
usernamestringThe account's username (case-insensitive).
setup_codestringThe 3–4 digit one-time setup code.
new_passwordstringNew password, 1–128 characters.
Rate limited to 5 attempts per 15 minutes. A code that has already been used or has expired returns setup_code_used / setup_code_expired.

Want language examples?

See the guides for C++, C#, and JavaScript.

SDK Guides

Ready to take your app security
to the next level?

Start free — auth, hardware-bound licensing and subscriptions in one API.

© 2026 Atheryx

Auth and licensing for Atheryx — secure by default.

Atheryx