KeyAux API Reference

Welcome to the KeyAux API documentation. KeyAux provides a powerful authentication and licensing platform with three API layers:

Authentication

KeyAux uses three authentication methods depending on the API:

Base URL

All API requests should be made to:

https://keyaux.caelen.workers.dev

All responses are JSON with the following structure:

{
  "success": true,
  "message": "Operation result",
  // ... additional data
}

Error Handling

KeyAux uses standard HTTP status codes alongside a success boolean in every response.

{
  "success": false,
  "message": "Username or email already exists"
}

Create a new KeyAux account. Returns a JWT token and user info. A default seller API key is automatically created.

Request Body

curl -X POST https://keyaux.caelen.workers.dev/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "myuser",
    "email": "me@example.com",
    "password": "securepass123"
  }'

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "user": {
    "id": "abc123...",
    "username": "myuser",
    "email": "me@example.com",
    "plan": "free"
  }
}

Log in with username (or email) and password. Returns a JWT token valid for 7 days.

Request Body

curl -X POST https://keyaux.caelen.workers.dev/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "myuser",
    "password": "securepass123"
  }'

{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "user": {
    "id": "abc123...",
    "username": "myuser",
    "email": "me@example.com",
    "plan": "free",
    "role": "user"
  }
}

Get the currently authenticated user's profile.

curl https://keyaux.caelen.workers.dev/api/dashboard/auth/me \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

{
  "success": true,
  "user": {
    "id": "abc123...",
    "username": "myuser",
    "email": "me@example.com",
    "plan": "free",
    "role": "user",
    "created_at": "2026-02-09T12:00:00.000Z"
  }
}

Change the authenticated user's password.

Request Body

curl -X PUT https://keyaux.caelen.workers.dev/api/dashboard/auth/password \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "current_password": "oldpass",
    "new_password": "newpass123"
  }'

Get aggregate stats across all your applications.

{
  "success": true,
  "stats": {
    "applications": 3,
    "users": 142,
    "licenses": 500,
    "logs": 1280
  }
}

Applications

Manage your applications. Each application has its own set of users, licenses, variables, and settings.

{
  "success": true,
  "applications": [
    {
      "id": "abc123",
      "name": "My App",
      "secret": "as_xxxx...",
      "version": "1.0",
      "hwid_lock": 1,
      "anti_vpn": 0,
      "paused": 0,
      "created_at": "2026-02-09T12:00:00.000Z"
    }
  ]
}

Licenses

Generate and manage license keys for your applications.

curl -X POST https://keyaux.caelen.workers.dev/api/dashboard/licenses/APP_ID \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "count": 5,
    "duration_days": 30,
    "mask": "XXXX-XXXX-XXXX-XXXX",
    "note": "Batch #1"
  }'

{
  "success": true,
  "licenses": [
    { "id": "abc...", "license_key": "A1B2-C3D4-E5F6-G7H8" },
    { "id": "def...", "license_key": "I9J0-K1L2-M3N4-O5P6" }
  ],
  "count": 5
}

Users

Manage end users (app users) who authenticate via the Client API.

Subscriptions

Manage subscription tiers for your applications.

Variables

Key-value store for your application. Supports global (app-wide) and per-user variables.

Global Variables

User Variables

Webhooks

Create webhooks that can be triggered from client applications.

Blacklist

Block IPs or hardware IDs from accessing your application.

Logs

View and manage activity logs for your applications.

Seller Keys

Manage API keys for the Seller API. Keys start with ka_.

Client API Overview

The Client API is designed for use in your desktop, mobile, or game applications. It is KeyAuth-compatible — existing KeyAuth SDKs and libraries will work with KeyAux.

Supported Request Types

Initialize a session. Must be called before any other client API request.

Parameters

curl -X POST https://keyaux.caelen.workers.dev/api/1.2/ \
  -H "Content-Type: application/json" \
  -d '{
    "type": "init",
    "name": "My App",
    "ownerid": "YOUR_ACCOUNT_ID",
    "ver": "1.0"
  }'

{
  "success": true,
  "message": "Initialized",
  "sessionid": "session_abc123...",
  "appinfo": {
    "numUsers": "142",
    "numOnlineUsers": "23",
    "numKeys": "500",
    "version": "1.0",
    "customerPanelLink": ""
  }
}

Login an end user. Validates credentials, HWID, subscription, and blacklist status.

Parameters

{
  "success": true,
  "message": "Logged in",
  "info": {
    "username": "player1",
    "subscriptions": [{
      "subscription": "default",
      "key": "",
      "expiry": "2026-03-09T12:00:00.000Z",
      "timeleft": 28,
      "level": "1"
    }],
    "ip": "1.2.3.4",
    "hwid": "ABC123DEF456",
    "createdate": "2026-01-09T12:00:00.000Z",
    "lastlogin": "2026-02-09T12:00:00.000Z"
  }
}

Register a new end user. Optionally requires a license key.

Parameters

Authenticate using only a license key (no user account required).

Parameters

Upgrade/extend a user's subscription using a license key.

Parameters

Check if a session is still valid.

Parameters

Get a user-specific variable. Requires an active logged-in session.

Parameters

Set a user-specific variable. Creates or updates.

Parameters

Get a global (app-wide) variable.

Parameters

Add a log entry from the client application.

Parameters

Execute a pre-configured webhook from the client.

Parameters

Fetch a list of currently online users.

Parameters

{
  "success": true,
  "users": [
    { "credential": "player1" },
    { "credential": "player2" }
  ]
}

Check if the current user's IP or HWID is blacklisted.

Parameters

Self-ban the currently logged-in user. Used as an anti-tamper mechanism.

Parameters

Seller API Overview

The Seller API allows programmatic management of licenses and users via API keys. Perfect for integrating with payment processors, Discord bots, or custom store fronts.

curl "https://keyaux.caelen.workers.dev/api/seller/?sellerkey=ka_xxx&type=add&appname=MyApp&expiry=30&amount=5"

Seller License Operations

{
  "success": true,
  "message": "License(s) created",
  "key": "A1B2C-D3E4F-G5H6I-J7K8L-M9N0P",
  "keys": ["A1B2C-...", "Q1R2S-..."]
}

Seller User Operations

Seller App Operations