Skip to content

License Server API

Welcome to the License Server API documentation! This comprehensive guide will help you integrate license management into your applications.

What is the License Server?

The License Server is an API for issuing, verifying, and tracking software licenses. Admin operations (issuing, revoking, listing) require a Bearer token; verification and activation endpoints are public, since a license key is meant to travel with the application it licenses. Rate limits vary by endpoint category — see Rate Limits for the full breakdown.

Quick Start

1. Health Check

First, let's verify the API is running:

bash
curl https://your-license-api.com/

Response:

json
{
  "message": "License API is running",
  "version": "1.0.0",
  "buildFingerprint": "a1b2c3d4e5f6"
}

2. Verify a License

Check if a license key is valid:

bash
curl -X POST https://your-license-api.com/v1/verify-license \
  -H "Content-Type: application/json" \
  -d '{
    "key": "7yChyZcfMG23Dx1sjBoLziPFrH4n-6f28"
  }'

3. Activate a License

Activate a license for a specific instance:

bash
curl -X POST https://your-license-api.com/v1/activate-license \
  -H "Content-Type: application/json" \
  -d '{
    "key": "7yChyZcfMG23Dx1sjBoLziPFrH4n-6f28",
    "instance_id": "server-001"
  }'

Key Concepts

License Key Format

  • Old Format (UUID): a1b2c3d4-e5f6-4789-9012-345678abcdef
  • New Format (Base58): 7yChyZcfMG23Dx1sjBoLziPFrH4n-6f28

New Key Format Benefits

  • 160-bit entropy vs UUID's 122-bit
  • No confusing characters (0, O, I, l excluded)
  • Shorter length for better usability
  • Metadata encoding for quick validation

Authentication

Two levels of access control — see Authentication for how to configure the admin key:

  • Public Endpoints - No authentication required
  • Admin Endpoints (Require Bearer token)

Documentation Sections

Need Help?