Avalex Licenses API — Issue, Update, and Delete Licenses

The /licenses resource is the core of Avalex’s licensing system. A license ties a specific product to a specific customer and controls how, where, and for how long their software can run. Each license tracks which IP addresses and hardware IDs (HWIDs) have been bound to it, records every validation attempt, and carries a version counter for safe concurrent updates. You can issue licenses manually, adjust slot limits, extend expiry dates, and clear bound devices — all through this API.

Required Permissions

Action	Permission
List / retrieve licenses	`licenses:read`
Create / update licenses	`licenses:write`
Delete licenses	`licenses:delete`

List All Licenses

string

required

Bearer <token> or Basic credentials.

Returns an array of all license records in your Avalex account.

curl http://localhost:8080/licenses \
  -H "Authorization: Bearer <token>"

Response — 200 OK

[
  {
    "id": "lic_12345",
    "productId": "prod_123",
    "customerId": "cust_123",
    "expiresAtEpochMillis": 1754676000000,
    "maxIps": 5,
    "maxHwids": 2,
    "usedIps": ["192.168.1.1"],
    "usedHwids": ["HWID-A1B2"],
    "version": 1,
    "validationAttempts": [],
    "createdAtEpochMillis": 1723140000000
  }
]

Create a License

string

required

Bearer <token> or Basic credentials.

string

required

ID of the product this license is issued for.

string

required

ID of the customer who owns this license.

number | null

Expiry timestamp in milliseconds. Set to null for a perpetual (never-expiring) license.

integer | null

Maximum number of IP addresses this license may bind to. Overrides the product-level default. Set to null for unlimited.

integer | null

Maximum number of hardware IDs this license may bind to. Overrides the product-level default. Set to null for unlimited.

Creates a new license and returns the created record.

curl -X POST http://localhost:8080/licenses \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "prod_123",
    "customerId": "cust_123",
    "expiresAtEpochMillis": 1754676000000,
    "maxIps": 5,
    "maxHwids": 2
  }'

Response — 201 Created

{
  "id": "lic_12345",
  "productId": "prod_123",
  "customerId": "cust_123",
  "expiresAtEpochMillis": 1754676000000,
  "maxIps": 5,
  "maxHwids": 2,
  "usedIps": [],
  "usedHwids": [],
  "version": 1,
  "validationAttempts": [],
  "createdAtEpochMillis": 1723140000000
}

Get a License by ID

string

required

The unique license ID (e.g. lic_12345).

Returns a single license record including its current bound IPs, HWIDs, and validation history. Responds with 404 Not Found if the license does not exist.

curl http://localhost:8080/licenses/lic_12345 \
  -H "Authorization: Bearer <token>"

Response — 200 OK

{
  "id": "lic_12345",
  "productId": "prod_123",
  "customerId": "cust_123",
  "expiresAtEpochMillis": 1754676000000,
  "maxIps": 5,
  "maxHwids": 2,
  "usedIps": ["192.168.1.1"],
  "usedHwids": ["HWID-A1B2"],
  "version": 1,
  "validationAttempts": [
    {
      "hwid": "HWID-A1B2",
      "ip": "192.168.1.1",
      "timestampEpochMillis": 1723140500000,
      "successful": true
    }
  ],
  "createdAtEpochMillis": 1723140000000
}

Update a License

string

required

The unique license ID.

Performs a full replacement of the license record. You must include all fields you want to retain. Returns 404 Not Found if the license does not exist.

This is a full replacement (PUT). To remove a bound HWID or IP address, omit it from the usedHwids or usedIps arrays in your request body. Any entries you include will be retained; any you omit will be cleared.

curl -X PUT http://localhost:8080/licenses/lic_12345 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "prod_123",
    "customerId": "cust_123",
    "expiresAtEpochMillis": 1786212000000,
    "maxIps": 5,
    "maxHwids": 2,
    "usedIps": ["192.168.1.1"],
    "usedHwids": [],
    "version": 1,
    "validationAttempts": []
  }'

Response — 200 OK

{
  "id": "lic_12345",
  "productId": "prod_123",
  "customerId": "cust_123",
  "expiresAtEpochMillis": 1786212000000,
  "maxIps": 5,
  "maxHwids": 2,
  "usedIps": ["192.168.1.1"],
  "usedHwids": [],
  "version": 2,
  "validationAttempts": [],
  "createdAtEpochMillis": 1723140000000
}

Delete a License

string

required

The unique license ID.

Permanently removes the license record. Returns 204 No Content on success and 404 Not Found if the ID does not exist.

curl -X DELETE http://localhost:8080/licenses/lic_12345 \
  -H "Authorization: Bearer <token>"

Response — 204 No Content

License Schema

Show License fields

string

Unique identifier for the license, assigned by Avalex on creation (e.g. lic_12345).

string

ID of the product this license was issued for.

string

ID of the customer who holds this license.

number | null

Expiry timestamp in milliseconds. null indicates the license never expires.

integer | null

Maximum number of IP addresses that can be bound to this license. null means unlimited. Overrides the product-level default when set explicitly.

integer | null

Maximum number of hardware IDs that can be bound to this license. null means unlimited. Overrides the product-level default when set explicitly.

string[]

Array of IP address strings currently bound to this license.

string[]

Array of hardware ID strings currently bound to this license.

integer

Monotonically incrementing version counter used for optimistic concurrency control. The server increments this on every successful update.

array

Array of validation attempt objects recorded when the license is checked by client software.

Show ValidationAttempt fields

string

Hardware ID presented during the validation attempt.

string

IP address from which the validation was made.

number

Unix timestamp in milliseconds of when the attempt occurred.

boolean

Whether the validation attempt succeeded.

number

Unix timestamp in milliseconds representing when this license was created.

Full Schema Example

{
  "id": "lic_12345",
  "productId": "prod_123",
  "customerId": "cust_123",
  "expiresAtEpochMillis": 1754676000000,
  "maxIps": 5,
  "maxHwids": 2,
  "usedIps": ["192.168.1.1"],
  "usedHwids": ["HWID-A1B2"],
  "version": 1,
  "validationAttempts": [
    {
      "hwid": "HWID-A1B2",
      "ip": "192.168.1.1",
      "timestampEpochMillis": 1723140500000,
      "successful": true
    }
  ],
  "createdAtEpochMillis": 1723140000000
}

Authentication

License Validation

Resources

Staff & Admin

Audit Logs

Avalex Licenses API — Issue, Update, and Delete Licenses

Required Permissions

List All Licenses

Create a License

Get a License by ID

Update a License

Delete a License

License Schema

Full Schema Example

​Required Permissions

​List All Licenses

​Create a License

​Get a License by ID

​Update a License

​Delete a License

​License Schema

​Full Schema Example

Required Permissions

List All Licenses

Create a License

Get a License by ID

Update a License

Delete a License

License Schema

Full Schema Example