Documentation v3.0
Status

LicenseCage API

Integrate LicenseCage license management directly into your billing system, reseller platform, automation tools, or custom applications.

API v1.2.6

The LicenseCage API provides programmatic access to license provisioning and management.

API Base URL: https://api.licensecage.com

Protocol: HTTPS

Request Format: GET or POST

Response Format: JSON

Requirements

Using the LicenseCage API requires a valid API token.

Your API token is available from your LicenseCage reseller account.

Authentication

API requests are authenticated using your LicenseCage API token.

GET Requests

Include your token using the token parameter.

https://api.licensecage.com/v1/license?token=YOUR_TOKEN&ip=LICENSE_IP&type=PRODUCT

POST Requests

For POST requests, use Bearer authentication:

Authorization: Bearer YOUR_TOKEN

Register License

Creates a new license for the specified IP address and product.

GET Request

GET https://api.licensecage.com/v1/license?token=YOUR_TOKEN&ip=LICENSE_IP&type=PRODUCT&billingcycle=1

Example

GET https://api.licensecage.com/v1/license?token=YOUR_TOKEN&ip=8.8.8.8&type=cpanel&billingcycle=1

Parameters

Parameter Description
token Your valid LicenseCage API token
ip The IP address for the license
type Product name
billingcycle License period in months

POST Request

POST /v1/license

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "ip": "8.8.8.8",
  "type": "cpanel",
  "billingcycle": "1"
}

Renew License

Renews an existing license for the selected billing period.

GET Request

GET https://api.licensecage.com/v1/renew?token=YOUR_TOKEN&ip=LICENSE_IP&type=PRODUCT&billingcycle=1

Example

GET https://api.licensecage.com/v1/renew?token=YOUR_TOKEN&ip=8.8.8.8&type=cpanel&billingcycle=1

Parameters

Parameter Description
token Your valid LicenseCage API token
ip Current license IP address
type Product name
billingcycle Renewal period in months

POST Request

POST /v1/renew

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "ip": "8.8.8.8",
  "type": "cpanel",
  "billingcycle": "1"
}

Change License IP

Changes the IP address assigned to an existing license.

GET Request

GET https://api.licensecage.com/v1/change-ip?token=YOUR_TOKEN&ip=LICENSE_IP&newip=NEW_LICENSE_IP&type=PRODUCT

Example

GET https://api.licensecage.com/v1/change-ip?token=YOUR_TOKEN&ip=103.213.28.220&newip=103.213.29.210&type=cpaneldedicated

Parameters

Parameter Description
token Your valid LicenseCage API token
ip Current license IP address
newip New license IP address
type Product name

POST Request

POST /v1/change-ip

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "ip": "103.213.28.220",
  "newip": "103.213.29.210",
  "type": "cpaneldedicated"
}

Change LiteSpeed Core

Changes the core level of a LiteSpeed license.

GET Request

GET https://api.licensecage.com/v1/change-core?token=YOUR_TOKEN&ip=LICENSE_IP&core=8

Example

GET https://api.licensecage.com/v1/change-core?token=YOUR_TOKEN&ip=8.8.8.8&core=8

Parameters

Parameter Description
token Your valid LicenseCage API token
ip LiteSpeed license IP address
core LiteSpeed core level

Supported core values: 2, 4, 8, 9.

Core value 9 represents XCore.

POST Request

POST /v1/change-core

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "ip": "8.8.8.8",
  "core": 8
}

Suspend License

Suspends an existing license.

GET Request

GET https://api.licensecage.com/v1/suspend?token=YOUR_TOKEN&ip=LICENSE_IP&type=PRODUCT

Example

GET https://api.licensecage.com/v1/suspend?token=YOUR_TOKEN&ip=8.8.8.8&type=cpanel

POST Request

POST /v1/suspend

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "ip": "8.8.8.8",
  "type": "cpanel"
}

Unsuspend License

Restores a suspended license.

GET Request

GET https://api.licensecage.com/v1/unsuspend?token=YOUR_TOKEN&ip=LICENSE_IP&type=PRODUCT

Example

GET https://api.licensecage.com/v1/unsuspend?token=YOUR_TOKEN&ip=8.8.8.8&type=cpanel

POST Request

POST /v1/unsuspend

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "ip": "8.8.8.8",
  "type": "cpanel"
}

Terminate License

Terminates an existing license.

GET Request

GET https://api.licensecage.com/v1/terminate?token=YOUR_TOKEN&ip=LICENSE_IP&type=PRODUCT

Example

GET https://api.licensecage.com/v1/terminate?token=YOUR_TOKEN&ip=8.8.8.8&type=cpanel

POST Request

POST /v1/terminate

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "ip": "8.8.8.8",
  "type": "cpanel"
}

Show Help

Returns license information for supported integrations.

GET Request

GET https://api.licensecage.com/v1/show-help?token=YOUR_TOKEN&serviceid=SERVICE_ID

Example

GET https://api.licensecage.com/v1/show-help?token=YOUR_TOKEN&serviceid=12345

Parameters

Parameter Description
token Your valid LicenseCage API token
serviceid License or service identifier

POST Request

POST /v1/show-help

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "serviceid": "12345"
}

Example Response

{
  "success": true,
  "api": "LicenseCage API",
  "version": "1.2.6",
  "request_id": "a1b2c3d4e5f67890",
  "data": {
    "validdirectory": "..."
  }
}

Billing Cycles

Use the following values for the billingcycle parameter.

Value Billing Period
1 Monthly
3 Quarterly
6 Semi-Annually
12 Annually
24 Biennially
36 Triennially

Supported Products

Use the corresponding product name as the type parameter.

Product Type
cPanel cpanel
cPanel Dedicated cpaneldedicated
CloudLinux CloudLinux
LiteSpeed LiteSpeed
LiteSpeed ADC LiteSpeedAdc
CXS Cxs
WHM Reseller WHMreseller
JetBackup JetBackup
Imunify360 imunify360
Plesk Linux VPS PleskLinuxVPS
Plesk Linux Dedicated PleskLinuxDedicated
DirectAdmin directadmin
DirectAdmin Reseller dareseller
WHMSonic whmsonic
OSM osm
Softaculous softaculous
Virtualizor virtualizor
WHMCS whmcs
SitePad sitepad
SYSCare SYSCare
CPGuard CPGuard
LiteSpeed 4 Core litespeed4core
LiteSpeed 8 Core litespeed8core
LiteSpeed XCore litespeedxcore
WP Squared wp2
Webuzo webuzo
Backuply backuply
KernelCare kernelcare
VirtFusion virtfusion

API Response

Successful requests return a JSON response containing the operation result and request ID.

{
  "success": true,
  "api": "LicenseCage API",
  "version": "1.2.6",
  "request_id": "a1b2c3d4e5f67890",
  "data": {
    "ok": true,
    "message": "Done"
  }
}

Error Responses

If an operation cannot be completed, the API returns a standardized error response.

{
  "success": false,
  "api": "LicenseCage API",
  "version": "1.2.6",
  "request_id": "a1b2c3d4e5f67890",
  "message": "License operation failed"
}

Use the request_id when contacting support about an API request.

HTTP Status Codes

Status Meaning
200 Request completed successfully
400 Invalid request or missing parameters
401 Invalid or missing API token
404 Endpoint not found
429 Rate limit exceeded
502 License operation failed
500 Internal API error

Rate Limit

LicenseCage API allows up to:

30 requests per minute

Requests exceeding the limit return HTTP status 429.

Example Integration

A billing system can create a one-month cPanel license using:

https://api.licensecage.com/v1/license?token=YOUR_TOKEN&ip=8.8.8.8&type=cpanel&billingcycle=1

The API returns the operation result as JSON.

PHP Example

<?php

$url = 'https://api.licensecage.com/v1/license';

$data = [
    'ip' => '8.8.8.8',
    'type' => 'cpanel',
    'billingcycle' => '1'
];

$ch = curl_init($url);

curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_TOKEN',
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode($data)
]);

$response = curl_exec($ch);

curl_close($ch);

echo $response;

Python Example

import requests

url = "https://api.licensecage.com/v1/license"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

data = {
    "ip": "8.8.8.8",
    "type": "cpanel",
    "billingcycle": "1"
}

response = requests.post(
    url,
    headers=headers,
    json=data
)

print(response.json())

Need help? Contact our support team for assistance.

📧 Contact Support