1. cPanel & WHM Documentation
  2. Manage2
  3. API
  4. Manage2 API Function - Request a License Transfer
manage2 m2api license

Manage2 API Function - Request a License Transfer

Last modified: December 7, 2022

Description

This function requests a license transfer between companies.

Examples

XML

https://manage2.cpanel.net/XMLtransferRequest.cgi?groupid=001&packageid=147&ip=192.0.2.0

JSON

https://manage2.cpanel.net/XMLtransferRequest.cgi?output=json&groupid=001&packageid=147&ip=192.0.2.0

YAML

https://manage2.cpanel.net/XMLtransferRequest.cgi?output=yaml&groupid=001&packageid=147&ip=192.0.2.0

<?php
include("cpl.inc.php");
$cpl = new cPanelLicensing("[email protected]", "123456luggage");
$cpl->requestTransfer(array(
        "ip"      => "192.0.2.0",
        "groupid" => "001",
        "packageid" => "147",
        )
    );
?>

use cPanelLicensing;
my $licenseManager = new cPanelLicensing(user => 'username\@example.com', pass => '123456luggage');
$licenseManager->requestTransfer(
    'groupid'   => '1234',
    'packageid' => '147',
    'ip'        => '192.0.2.0'
    );

<XMLtransferRequest reason="Example Company has been contacted. You will receive notice via email once our staff reviews their response. This process may take up to 48 hours. The confirmation number for this request is 37313." status="1" version="0.2"/>

{
    "version": 0.2,
    "status": 1,
    "reason": "Example Company has been contacted. You will receive notice via email once our staff reviews their response. This process may take up to 48 hours. The confirmation number for this request is 37313."
}

---
version: 0.2
status: 1
reason: Example Company has been contacted. You will receive notice via email once our staff reviews their response. This process may take up to 48 hours. The confirmation number for this request is 37313.

Parameters

This function accepts the following parameters:

Parameter Type Description Example
groupid integer Required
The license’s group ID. The Manage2 Display Groups function returns a list of possible values.		 001
packageid integer Required
The package’s ID number. The Manage2 List Package Information function returns a list of possible values.		 147
ip integer Required
A valid IP address on the server. The Manage2 List License Information function returns a list of possible values.		 192.0.2.01

Returns

This function returns the following values:

Return Type
Description
 Example
reason string The transfer request’s result. Example Company has been contacted. You will receive notice via email once our staff reviews their response. This process may take up to 48 hours. The confirmation number for this request is 37313.
status Boolean Whether the function succeeded:
  • 1 — Success.
  • 0 — Failure.
 1
version numeric Internal information that the Manage2 API uses to identify the version. 0.1

Additional Documentation