Manage2 API Function - Add Licenses
Last modified: July 24, 2023
Description
This function adds a new license to a Manage2 account.
Examples
Browser-based calls
XML
https://manage2.cpanel.net/XMLlicenseAdd.cgi?ip=192.0.2.0&packageid=8&groupid=13&force=1&dryrun=0&maxusers=120&external_notes=testlicense
JSON
https://manage2.cpanel.net/XMLlicenseAdd.cgi?output=json&ip=192.0.2.0&packageid=008&groupid=013&force=1&dryrun=0&maxusers=120&external_notes=testlicense
YAML
https://manage2.cpanel.net/XMLlicenseAdd.cgi?output=yaml&ip=192.0.2.0&packageid=008&groupid=013&force=1&dryrun=0&maxusers=120&external_notes=testlicense
cPanelLicensing PHP Class
|
|
cPanelLicensing Perl Module
|
|
Output (XML)
<XMLlicenseAdd licenseid="6793969" monthly_price="21.34" price="0.00" promoinfo="" reason="Activated EXAMPLECOMPANY license on 192.0.2.0 in the 'example' group." status="1" yearly="0"/>
Output (JSON)
|
|
Output (YAML)
|
|
Parameters
This function accepts the following parameters:
Parameter | Type | Description | Example |
---|---|---|---|
ip |
string | The IP address for which to add a license.
Note:
360 Monitoring and Koality licenses do not require this parameter.
|
192.0.2.0 |
packageid |
string | Required The package’s ID number. The Manage2 List Package Information function returns a list of possible values. | 008 |
servers |
integer | A positive integer for the total number of server monitors for a 360 Monitoring license.
Note:
|
1 |
sites |
integer | A positive integer greater than or equal to 20 for the total number of site monitors for a 360 Monitoring license.
Note:
|
20 |
projects |
integer | The total number of additional projects for a Koality license. This parameter defaults to 0 . |
30 |
groupid |
string | Required The ID of the group to which to add the license. The Manage2 Display Groups function returns a list of possible values. | 013 |
force or reactivateok |
Boolean | Whether to forcibly add the license to the specified IP address:
1 . |
0 |
dryrun |
Boolean | Whether to display error messages and price information, but not activate the license:
0 . |
1 |
maxusers |
integer | The maximum number of users allowed on the license. | 120 |
external_notes |
string | A space for additional information associated with the license, up to 64 characters long.
Warning:
If the parameter’s value exceeds 64 characters, this function will return an error.
|
testlicense |
Returns
This function returns the following values:
Return | Type | Description | Example |
---|---|---|---|
activation_code |
string | The activation code for a 360 Monitoring or Koality license. | ABC123-1Q2W3E-BMW555-V5F4R3-HJKL98 |
activation_link |
string | The link to use to activate a 360 Monitoring or Koality license. | https://app.360monitoring.com/license/activate/ABC123-1Q2W3E-BMW555-V5F4R3-HJKL98 |
licenseid |
integer | The new license ID. | 6793969 |
monthly_price |
numeric | The monthly base price of a license, in US dollars. | 21.34 |
price |
numeric | The price for a license, in US dollars. | 100.00 |
promoinfo |
string | Information about any applied promotional rates. One of:
|
"" |
reason |
string | Information about the license activation. | Activated EXAMPLECOMPANY license on 192.0.2.0 in the 'example' group. |
servers |
integer | The number of server monitors in the 360 Monitoring license. This must be a positive integer. | 1 |
sites |
integer | The number of site monitors in the 360 Monitoring license. This must be a positive integer greater than or equal to 20. | 20 |
projects |
integer | A positive integer for the total number of projects for a Koality license. | 30 |
status |
Boolean | Whether the function succeeded:
|
1 |
yearly |
Boolean | Whether the license is a yearly license:
|
0 |