The Installatron Plugin Licensing API is a simple HTTP API that enables Installatron Plugin licensing to be automated. Licenses can also be managed through the standard Installatron Licensing Portal.
Annual and monthly licenses are billed on the 1st of the next month. Automatic renewal is enabled by default for all licenses.
An API authentication key is used in place of your account's login credentials. API authentication keys are managed through your Installatron account.
JONS is the standard output of the API.
Please contact Installatron Support with any questions.
Sample request to order a monthly dedicated server license:
https://installatron.com/account/licenses?api=json&authkey=HIDDEN&type=monthly&ip=1.2.3.4
Sample request to order an annual VPS license:
https://installatron.com/account/licenses?api=json&authkey=HIDDEN&type=annual&ip=1.2.3.4&vps=true&autorenew=true
Distributor accounts only: Sample request to order an external monthly dedicated server license:
https://installatron.com/account/licenses?api=json&authkey=HIDDEN&type=monthly&ip=1.2.3.4&external=true
ip is IP address the license will be assigned to.
type is the term of the license. Valid values: monthly or annual
vps is an optional parameter that flags the license as VPS-only.
note is an optional parameter containing a custom string (up to 250 characters) that better describes the license, which could be a customer contract number or tag.
autorenew is an optional parameter that controls whether Automatic Renewal is enabled for the license. Defaults to Enabled.
external is an optional parameter that flags the license as external. This field will only works for distributor accounts.
Sample success response for a monthly license:
{ "result": true, "license_id": 3134212737, "expires": "2025-12-01", "billed": 0.00, "autorenew": true }
license_id is the internal ID of the purchased license. This is a randomized INT(10).
expires is the next date the license will be due for renewal. Format: YYYY-MM-DD
billed is amount billed to a saved payment method. Monthly licenses are not billed until the 1st of the next month.
Sample failure response:
{ "result": false, "message": "No payment method on file" }
message is a url-encoded string describing why the failure occurred.
https://installatron.com/account/licenses?api=json&authkey=HIDDEN&ip=1.2.3.4
license_id is an optional parameter that allows the result set to be filtered by license ID specifically.
ip is an optional parameter that allows the result set to be filtered by license IP address specifically.
q is an optional general search parameter that allows the result set to be filtered by license hostname, license IP, or license ID. Other filters can be included as well. For example, including :active in the query limits the result to active licenses. Other available filters include :unused and :expiring. If not included, all licenses are displayed.
fields[autorenew] is an optional parameter that triggers the inclusion of Automatic Renewal status in the output.
fields[note] is an optional parameter that triggers the inclusion of the license note in the output.
[{"license_id":19847,"type":"monthly","expires":"2015-12-01","ip":"1.2.3.4","vps":true}]
license_id is the internal ID of the license. Format: Integer.
type is the license term. Valid values are 'monthly', 'annual', and 'lifetime'.
expires is the next date the license will be due for renewal. Format: YYYY-MM-DD
ip is the licensed IPv4 or IPv6 address.
hostname is the licensed server's hostname. This value is for display purposes only and will update from time to time; it is not associated with licensing.
autorenew is the license's automatic renewal status. Format: boolean
note is the license's note. This is a custom string (up to 250 characters) that better describes the license, which could be a customer contract number or tag.
Sample failure response:
{"result": false, "message": "No licenses matched"}
message is a url-encoded string describing why the failure occurred.
https://installatron.com/account/licenses?api=csv&authkey=HIDDEN&q=1.2.3.4
license_id,type,expires,ip,vps 19847,monthly,2015-12-01,1.2.3.4,true
Sample failure response:
result=false&message=No licenses matched
https://installatron.com/account/licenses?api=&authkey=HIDDEN&q=1.2.3.4
0[license_id]=19847&0[type]=monthly&0[expires]=2015-12-01&0[ip]=1.2.3.4&0[vps]=true
Tip: Passing the full result through PHP's parse_str function makes parsing easy.
Sample failure response:
result=false&message=No licenses matched
https://installatron.com/account/licenses?api=json&authkey=HIDDEN&ip[19847]=1.2.3.4
ip[license_id] is the IP address the license by the ID license_id is to be updated to.
{"result": true}
Sample failure response:
{"result": false}
https://installatron.com/account/licenses?api=json&authkey=HIDDEN¬e[19847]=My%20note
note[license_id] is the parameter containing a custom string (up to 250 characters) that better describes the license, which could be a customer contract number or tag.
{"result": true}
Sample failure response:
{"result": false}
https://installatron.com/account/licenses?api=json&authkey=HIDDEN&task=terminate&ip=1.2.3.4
ip is the IP address of the license to be terminated.
{"result": true, "ip": "1.2.3.4"}
license_ip is the IP address of the license that is now terminated.
Sample failure response:
{"result": false, "message": "No license found by the IP 1.2.3.4"}
message is a url-encoded string describing why the failure occurred.
https://installatron.com/account/licenses?api=json&authkey=HIDDEN&task=terminate&license_id=5193
license_id is the internal ID of the license to be terminated.
{"result": true, "license_id": 5193}
license_id is the internal ID of the license that is now terminated.
Sample failure response:
{"result": false, "message": "No license found by the ID 5193"}
message is a url-encoded string describing why the failure occurred.