Manage2 API Function - Cancel a License Transfer


Last modified: March 12, 2021

Description

This function cancels an existing request to transfer a license.

Examples

XML

https://manage2.cpanel.net/XMLtransferRequest.cgi?cancel=1&groupid=0001&packageid=0001&ip=192.0.2.0

JSON

https://manage2.cpanel.net/XMLtransferRequest.cgi?output=json&cancel=1&groupid=0001&packageid=0001&ip=192.0.2.0

YAML

https://manage2.cpanel.net/XMLtransferRequest.cgi?output=yaml&cancel=1&groupid=0001&packageid=0001&ip=192.0.2.0

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
<?php
include("cpl.inc.php");
$cpl = new cPanelLicensing("username@example.com","123456luggage");
$lisc = $cpl->requestTransfer(array(
        "ip" = 192.0.2.0,
        "groupid" => 001,
        "packageid" => 001,
        "cancel" => 1
    )
);
?>

1
2
3
4
5
6
7
8
use cPanelLicensing;
    my $cpl = cPanelLicensing->new(user => "username\@example.com, pass => "123456luggage");
    $cpl->requestTransfer(
        'groupid'   => '192.0.2.0',
        'packageid' => '001',
        'ip'        => '001',
        'cancel'    => '1'
    );

<XMLtransferRequest reason="Cancelled transfer request" status="1" version="0.2"/>

1
2
3
4
5
{
    "version": 0.2,
    "status": 1,
    "reason": "Cancelled transfer request"
}

1
2
3
4
---
version: 0.2
status: 1
reason: Cancelled transfer request

Parameters

This function accepts the following parameters:

Parameter Type Description Example
ip string Required
The license account’s IP address. The Manage2 List Package Information function returns a list of possible values.
192.0.2.01
cancel Boolean Required
Whether to cancel the transfer:
  • 1 — Cancel the transer.
  • 0 — Do not cancel the transfer.
1
groupid integer The license’s group ID. The Manage2 Display Groups function returns a list of possible values.

This parameter defaults to an empty string.
001
packageid integer The license’s package ID. The Manage2 List Package Information function returns a list of possible values.

This parameter defaults to an empty string.
001

Returns

This function returns the following values:

Return Type Description Example
reason string The transfer request’s result. Cancelled transfer request
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