1. cPanel & WHM Documentation
  2. Manage2
  3. API
  4. Manage2 API Function - Add Licenses
manage2 m2api license

Manage2 API Function - Add Licenses

Last modified: 2024 December 19

Description

This function adds a new license to a Manage2 account.

Examples

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

<?php
include("cpl.inc.php");
$cpl = new cPanelLicensing("[email protected]", "123456luggage");
$lisc = (array)$cpl->activateLicense(array(
    "ip"          => "192.0.2.0",
    "groupid"     => "013",
    "packageid"   => 008",
    "force"       => "1",
    "dryrun"      => "0",
    "maxusers"      => "120",
    "external_notes"    => "testlicense"
    )
);
?>


 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

use cPanelLicensing;
my $licenseManager = new cPanelLicensing(user => "username\@example.com", pass => "123456luggage");
my $liscid = $licenseManager->activateLicense(
    'ip'          => '192.0.2.0',
    'groupid'     => '013',
    'packageid'   => '008',
    'force'       => '1',
    "dryrun"      => "0",
    "maxusers"      => "120",
    "external_notes"    => "testlicense"
);

<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"/>

1
2
3
4
5
6
7
8
9

{
    "monthly_price": "21.34",
    "status": 1,
    "yearly": 0,
    "reason": "Activated EXAMPLECOMPANY license on 192.0.2.0 in the 'example' group.",
    "price": "100.00",
    "promoinfo": "",
    "licenseid": "6793969"
}

1
2
3
4
5
6
7
8

---
monthly_price: '21.34'
status: 1
yearly: 0
reason: Activated EXAMPLECOMPANY license on 192.0.2.0 in the 'example' group.
price: '100.00'
promoinfo: ''
licenseid: '6793969'

Parameters

This function accepts the following parameters:

Parameter Type Description Example
ip string Required
The IP address for which to add a license.
Note:

The following licenses do not require this parameter:

  • 360 Monitoring
  • koality
  • Sitejet Commerce
  • Sitejet Studio
  • SocialBee
  • WP Guardian
 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.
Note:
  • If you do not use this parameter, the return’s value is the default from the 360 Monitoring package.
  • This parameter is optional and only applies to a 360 Monitoring license.
 1
users integer This parameter is optional and only applies to SocialBee licenses. It represents the number of additional users to add to a SocialBee license, and must be a positive integer. 1
profiles integer This parameter is optional and only applies to SocialBee licenses. It represents the number of additional profiles to add to a SocialBee license, and must be a positive multiple of 5. 5
workspaces integer This parameter is optional and only applies to SocialBee licenses. It represents the number of additional workspaces to add to a SocialBee license, and must be a positive integer. 1
sites integer This parameter is optional and only applies to 360 Monitoring, WP Guardian, or WP Guardian (cPanel Addon) licenses. Its value depends on your license type.
  • For 360 Monitoring licenses, this parameter represents the total number of site monitors. Its value must be a positive integer greater than or equal to 20.
  • For WP Guardian and WP Guardian (cPanel Addon) licenses, this parameter represents the number of sites to add to the selected package. Its value must be a positive integer.
Note:

If you do not use this parameter, the sites return value is the default from the 360 Monitoring or WP Guardian package.

 20
hosted_sites integer A positive integer for the total number of hosted sites on a Sitejet Studio license.

This parameter defaults to 1.
Note:
This parameter is optional and only applies to Sitejet Studio licenses.
1
self_hosted_sites integer A positive integer for the total number of self-hosted sites on a Sitejet Studio license.

This parameter defaults to 0.
Note:
This parameter is optional and only applies to Sitejet Studio licenses.
1
projects integer The total number of additional projects for a koality license.

This parameter defaults to 0.		 30
groupid string The ID of the group to which to add the license.
  • The Manage2 Display Groups function returns a list of possible values.
  • This parameter defaults to the default group.
 013
force
or
reactivateok		 Boolean Whether to forcibly add the license to the specified IP address:
  • 1 — Forcibly add the license.
  • 0 — Do not forcibly add the license.
This parameter defaults to 1.		 0
dryrun Boolean Whether to display error messages and price information but not activate the license:
  • 1 — Display fee information but do not activate the license.
  • 0 — Do not display fee information but activate the license.
This parameter defaults to 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 license of the following types:
  • 360 Monitoring
  • koality
  • Sitejet Commerce
  • Sitejet Studio
  • SocialBee
  • WP Guardian
  • WP Guardian (cPanel Addon)
 ABC123-1Q2W3E-BMW555-V5F4R3-HJKL98
activation_link string The link to use to activate a license of the following types:
  • 360 Monitoring
  • koality
  • Sitejet Commerce
  • Sitejet Studio
  • SocialBee
  • WP Guardian
  • WP Guardian (cPanel Addon)
Note:
WP Guardian (cPanel Addon) licenses always return a blank string as the activation_link value.
https://app.360monitoring.com/license/activate/ABC123-1Q2W3E-BMW555-V5F4R3-HJKL98
hosted_sites integer The total number of hosted sites on a Sitejet Studio license. 1
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
products_included string The total number of products you can display in the web stores you create with Sitejet Commerce. One of:
  • 100
  • 2500
  • unlimited
 100
profiles integer The number of additional profiles you added to a SocialBee license.

If you did not add this parameter, this return’s value is 0.		 5
projects integer A positive integer that represents the total number of projects for a koality license. 30
promoinfo string Information about any applied promotional rates. One of:
  • A string value.
  • "" — No promotion applied.
 ""
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 This return value depends on your license type.
  • For 360 Monitoring licenses, this is the number of site monitors. This must be a positive integer that is greater than or equal to 20.
  • For WP Guardian licenses, this is the number of sites. This must be a positive integer.
 20
self_hosted_sites integer The total number of self-hosted sites on a Sitejet Studio license. 1
status Boolean Whether the function succeeded:
  • 1 — Success.
  • 0 — Failure.
 1
users integer The number of additional users you added to a SocialBee license.

If you did not add this parameter, this return’s value is 0.		 1
workspaces integer The number of additional workspaces you added to a SocialBee license.

If you did not add this parameter, this return’s value is 0.		 1
wpcga_sites integer The number of sites for a WP Guardian (cPanel Addon) license. 100
yearly Boolean Whether the license is a yearly license:
  • 1 — A yearly license.
  • 0 — Not a yearly license.
 0

Additional Documentation