Introduction

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.

How is billing handled?

Annual and monthly licenses are billed on the 1st of the next month. Automatic renewal is enabled by default for all licenses.

How does the API authenticate?

An API authentication key is used in place of your account's login credentials. API authentication keys are managed through your Installatron account.

Can I receive API output in JSON format?

Yes, simply use "api=json" instead of "api=" for the request.

Questions?

Please contact Installatron Support with any questions.

Table of contents

• Add/Provision a license
• List licenses (with optional filtering)
• List licenses in CSV format
• List licenses in JSON format
• Update/Reassign license IP(s)
• Terminate/Expire a license

Add/Provision a license

Sample requests

Sample request to order a monthly dedicated server license:

https://installatron.com/account/licenses?api=&authkey=HIDDEN&type=monthly&ip=1.2.3.4

Sample request to order an annual VPS license:

https://installatron.com/account/licenses?api=&authkey=HIDDEN&type=annual&ip=1.2.3.4&vps=true

Distributor accounts only: Sample request to order an external monthly dedicated server license:

https://installatron.com/account/licenses?api=&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 field that flags the license as VPS-only.
external is an optional field that flags the license as external. This field will only works for distributor accounts.

Sample responses

Sample success response for a monthly license:

result=true&license_id=3134212737&expires=2024-12-01&billed=0.00

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.

List licenses (with optional filtering)

Sample requests

https://installatron.com/account/licenses?api=&authkey=HIDDEN&ip=1.2.3.4

license_id is an optional field that allows the result set to be filtered by license ID specifically.
ip is an optional field that allows the result set to be filtered by license IP address specifically.
q is an optional general search field 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.

Sample response for each license

0[license_id]=19847&0[type]=monthly&0[expires]=2015-12-01&0[ip]=1.2.3.4&0[vps]=true

n[license_id] is the internal ID of the license. Format: INT(10).
n[type] is the license term. Valid values are 'monthly', 'annual', and 'lifetime'.
n[expires] is the next date the license will be due for renewal. Format: YYYY-MM-DD
n[ip] is the licensed IPv4 or IPv6 address.
n[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.

Tip: Passing the full result through PHP's parse_str function makes parsing easy.

Sample failure response:

result=false&message=No licenses matched

message is a url-encoded string describing why the failure occurred.

List licenses in CSV format

Sample request

https://installatron.com/account/licenses?api=csv&authkey=HIDDEN&q=1.2.3.4

Sample response

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

List licenses in JSON format

Sample request

https://installatron.com/account/licenses?api=json&authkey=HIDDEN&q=1.2.3.4

Sample response

A list of licenses in JSON format is returned.

[{"license_id":19847,"type":"monthly","expires":"2015-12-01","ip":"1.2.3.4","vps":true}]

Sample failure response:

result=false&message=No licenses matched

Update/Reassign license IP(s)

Sample requests

https://installatron.com/account/licenses?api=&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.

Sample responses

result=true

Sample failure response:

result=false

Terminate/Expire a license (by IP address)

Sample requests

https://installatron.com/account/licenses?api=&authkey=HIDDEN&task=terminate&ip=1.2.3.4

ip is the IP address of the license to be terminated.

Sample responses

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.

Terminate/Expire a license (by ID)

Sample requests

https://installatron.com/account/licenses?api=&authkey=HIDDEN&task=terminate&license_id=5193

license_id is the internal ID of the license to be terminated.

Sample responses

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.