Page tree
Skip to end of metadata
Go to start of metadata

Description

This function cancels an existing request to transfer a license.

Examples 


 Browser-based Calls
XML
https://manage2.cpanel.net/XMLtransferRequest.cgi?cancel=1&groupid=0001&packageid=0001&ip=127.0.0.1
JSON
https://manage2.cpanel.net/XMLtransferRequest.cgi?output=json&cancel=1&groupid=0001&packageid=0001&ip=127.0.0.1
YAML
https://manage2.cpanel.net/XMLtransferRequest.cgi?output=yaml&cancel=1&groupid=0001&packageid=0001&ip=127.0.0.1
 cPanel Licensing PHP Class
<?php
 
include("cpl.inc.php");
 
$cpl = new cPanelLicensing("barney@example.com","12345luggage");
$lisc = $cpl->requestTransfer(array(
        "ip" = 127.0.0.1,
        "groupid" => 001,
        "packageid" => 001,
        "cancel" => 1
    )
);
?>
 cPanel Licensing Perl Module
use cPanelLicensing;
    my $cpl = cPanelLicensing->new(user => "barney\@example.com, pass => "12345luggage");
    $cpl->requestTransfer(
        'groupid'   => '127.0.0.1',
        'packageid' => '001',
        'ip'        => '001',
        'cancel'    => '1'
    );
 Output (JSON)
{
  "version": 0.2,
  "status": 1,
  "reason": "Cancelled transfer request" 
}
 Output (XML)
<XMLtransferRequest reason="Cancelled transfer request" status="1" version="0.2"/>
 Output (YAML)
--- 
reason: "Cancelled transfer request"
status: 1
version: 0.2

Parameters

ParameterTypeDescriptionPossible valuesExample
ipstring

Required

The license account's IP address.

A valid IP address on the server.

Note:

The List License Information function returns a list of possible values.

127.0.0.11
cancelBoolean

Required

Whether to cancel the transfer.

  • 1 — Cancel the transfer.
  • 0 — Do not cancel the transfer.
1
groupidinteger

The license's group ID.

This parameter defaults to an empty string.

The group's ID number.

Note:

The Display Groups function returns a list of possible values.

001
packageidinteger

The license's package ID.

This parameter defaults to an empty string.

The package's ID number

Note:

The List Package Information function returns a list of possible values.

001

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstringThe transfer request's result.A string value.
Cancelled transfer request
statusBooleanWhether the function succeeded.
  • 1 — Success.

  • 0 — Failure.
1
versionnumericInternal information that the Manage2 API uses to identify the version.A numeric value.0.1