LicensePal API

Version v1.4 – Released 22nd April 2020

General API Guidelines

The LicensePal API accepts requests via both POST and GET. Returns from our API will always be
in JSON format. In order to gain access to the API, you must open a ticket with us asking for
access. All API access requests must be approved by our staff and we will then provide you with
a secure API key.

In order to purchase and activate licenses via our API, you must either have a credit balance or
a credit card on file. If you do not meet this requirement, then an order will be generated, but
not activated until manual payment is made.

LicensePal is not responsible for assistance with integrating the API with other software. While
we are more than happy to answer general API questions, we cannot provide coding assistance
in any way.

Page 1
 Contents
Accessing the API ...................................................................................................................................... 3
Listing Licenses .......................................................................................................................................... 4
Creating Licenses ...................................................................................................................................... 5
Suspending Licenses ................................................................................................................................. 8
Expiring Licenses ..................................................................................................................................... 10
Modifying Licenses.................................................................................................................................. 11

Page 2
 Accessing the API

The base URL for all API calls is as follows:

https://licensepal.com/manage/api/index.php

All requests require the apiuser, apikey and action parameters to be passed.

Required Parameters Value

apiuser Email address on account
apikey Provided secure API key
action list, create, suspend, unsuspend, terminate or modify

Possible Parameters Possible Values

blesta, clientexec, cloudlinux, cpanel, imunify360, installatron,
product interworx, kernelcare, litespeed, rvsitebuilder, rvskin, sitepad,
softaculous, solusvm, virtualizor, whmsonic or whmxtra
lid LicensePal issued license ID
coupon Coupon code
ip IP address for license
domain Domain for license
5, 30, 100, 125, 150, 175, 200, 225, 250, 300, 350, 400, 450,
500, 550, 600, 650, 700, 750, 800, 850, 900, 950, 1000, 1050,
accounts
1100, 1150, 1200, 1250, 1300, 1350, 1400, 1450 or 1500 (for
cPanel)
vps true
0 or 1 (for SolusVM)
site_owner, site_owner_plus, web_host_lite,
type
web_host_essential, web_host_professional,
web_host_enterprise or web_host_elite (for LiteSpeed)
users 1, 30, 250 or unlimited (for imunify360)
limited true (for InterWorx)
slaves Integer (for SolusVM)
minislaves Integer (for SolusVM)
microslaves Integer (for SolusVM)

Page 3
 Listing Licenses

This function lists all licenses under your account.

Parameters Value
apiuser Email address on account
apikey Provided secure API key
action list

Example Call

https://licensepal.com/manage/api/index.php?apiuser=[YOUR_EMAIL]&apike
y=[YOUR_API_KEY]&action=list

Example Success Output

{
"status": "success",
"license": [
{
"lid": "12345",
"orderid": "12345",
"productname": "ClientExec Leased License",
"amount": "12.95",
"cycle": "Monthly",
"nextduedate": "2015-03-29",
"status": "Active",
"product": "clientexec",
"domain": "test.licensepal.com"
},
...
]
}

Page 4
 Creating Licenses

This function will generate a new license under your account.

Parameters Value
apiuser Email address on account
apikey Provided secure API key
action create

blesta, clientexec, cloudlinux, cpanel, imunify360, installatron,

product interworx, kernelcare, litespeed, rvsitebuilder, rvskin, sitepad,
softaculous, solusvm, virtualizor, whmsonic or whmxtra

ClientExec
domain Domain name for license
CloudLinux
ip IP address for license
cPanel
ip IP address for license
vps true for Cloud (VPS) license (optional, default false)
5 (Cloud only), 30 (Cloud only), 100, 125, 150, 175, 200, 225,
250, 300, 350, 400, 450, 500, 550, 600, 650, 700, 750, 800, 850,
accounts
900, 950, 1000, 1050, 1100, 1150, 1200, 1250, 1300, 1350,
1400, 1450 or 1500
Imunify360
ip IP address for license
users 1, 30, 250 or unlimited (optional, default unlimited)
Installatron
ip IP address for license
vps true for VPS license (optional, default false)
InterWorx
vps true for VPS license (optional, default false)
limited true for limited license (optional, default false)

Page 5
 KernelCare
ip IP address for license
LiteSpeed
site_owner, site_owner_plus, web_host_lite,
type web_host_essential, web_host_professional,
web_host_enterprise or web_host_elite
RVSiteBuilder
ip IP address for license
vps true for VPS license (optional, default false)
RVSkin
ip IP address for license
vps true for VPS license (optional, default false)
SitePad
ip IP address for license
Softaculous
ip IP address for license
vps true for VPS license (optional, default false)
SolusVM
type 0 for Enterprise, 1 for Slave Only (optional, default 0)
slaves Integer (optional, default 0)
minislaves Integer (optional, default 0)
microslaves Integer (optional, default 0)
Virtualizor
ip IP address for license
WHMSonic
ip IP address for license

Example Call

https://licensepal.com/manage/api/index.php?apiuser=[YOUR_EMAIL]&apike
y=[YOUR_API_KEY]&action=create&product=[LICENSE_TYPE]&ip=[IP_ADDR]

Page 6
Example Success Output

{
"status": "success",
"message": "Order Added",
"orderid": "12345",
"lid": "12345"
}

Example Error Output

{
"status": "failure",
"message": "Parameter 'ip' required."
}

Page 7
 Suspending Licenses

This function will suspend an active license in your account.

Parameters Value
apiuser Email address on account
apikey Provided secure API key
action suspend
lid LicensePal issued license ID

Example Call

https://licensepal.com/manage/api/index.php?apiuser=[YOUR_EMAIL]&apike
y=[YOUR_API_KEY]&action=suspend&lid=[LICENSE_ID]

Example Success Output

{
"status": "success",
"message": "License Suspended",
"lid": "12345"
}

Example Error Output

{
"status": "failure",
"message": "Suspend failed."
}

Page 8
 Unsuspending Licenses

This function will unsuspend a suspended license in your account.

Parameters Value
apiuser Email address on account
apikey Provided secure API key
action unsuspend
lid LicensePal issued license ID

Example Call

https://licensepal.com/manage/api/index.php?apiuser=[YOUR_EMAIL]&apike
y=[YOUR_API_KEY]&action=unsuspend&lid=[LICENSE_ID]

Example Success Output

{
"status": "success",
"message": "License Unsuspended",
"lid": "12345"
}

Example Error Output

{
"status": "failure",
"message": "This license is not currently suspended."
}

Page 9
 Terminating Licenses

This function terminates an existing license under your account.

Parameters Value
apiuser Email address on account
apikey Provided secure API key
action terminate
lid LicensePal issued license ID

Example Call

https://licensepal.com/manage/api/index.php?apiuser=[YOUR_EMAIL]&apike
y=[YOUR_API_KEY]&action=terminate&lid=[LICENSE_ID]

Example Success Output

{
"status": "success",
"message": "License Terminates",
"lid": "12345"
}

Example Error Output

{
"status": "failure",
"message": "This license has already been terminated."
}

Page 10
 Modifying Licenses

This function changes the domain/IP on an existing license.

Parameters Value
apiuser Email address on account
apikey Provided secure API key
action modify
lid LicensePal issued license ID
ClientExec
domain Domain name for license
CloudLinux
ip IP address for license
cPanel
ip IP address for license
Imunify360
ip IP address for license
Installatron
ip IP address for license
KernelCare
ip IP address for license
RVSiteBuilder
ip IP address for license
RVSkin
ip IP address for license
SitePad
ip IP address for license
Softaculous
ip IP address for license
SolusVM
slaves Integer (optional)

Page 11
minislaves Integer (optional)
microslaves Integer (optional)
Virtualizor
ip IP address for license
WHMSonic
ip IP address for license

Example Call

https://licensepal.com/manage/api/index.php?apiuser=[YOUR_EMAIL]&apike
y=[YOUR_API_KEY]&action=modify&lid=[LICENSE_ID]&ip=[IP_ADDR]

Example Success Output

{
"status": "success",
"message": "License Modified",
"lid": "12345"
}

Example Error Output

{
"status": "failure",
"message": "The 'ip' parameter is required."
}

Page 12