Difference: XMLLookupID (12 vs. 13)

Revision 1331 Jan 2012 - MelanieSeibert

Line: 1 to 1
 
META TOPICPARENT name="ManageTwo.Manage2Api"

Look up a License ID — XMLlookup.cgi

Deleted:
<
<
This Manage2 function allows you to retrieve the license ID associated with an IP address.
 
Added:
>
>
This Manage2 function allows you to retrieve the license ID associated with an IP address.
 

Variables

Input

Changed:
<
<
  • ip (string) — The IP address that corresponds to the license ID you wish to retrieve.
>
>
The following variable is required:
  • ip (string) — The IP address that corresponds to the license ID you wish to retrieve.

The following variables are optional:

  • packageid (integer) — The package that corresponds to the license ID you wish to retrieve.
  • all (boolean) — Whether to return all licenses currently associated with the specified IP address.
    • 1 — yes
    • 0 — no (returns the first active license on the IP address)
 

Output

Changed:
<
<
  • licenseid (string) — The license ID associated with the IP address.
>
>
  • licenseid (string, or list if all=1 ) — The license ID(s) associated with the IP address.
 
    • Example: 0001
Changed:
<
<
  • reason (string) — Information about the license ID lookup.
  • status (boolean) — Whether the lookup was successful.
>
>
  • reason (string) — Information about the license ID lookup.
  • status (boolean) — Whether the lookup was successful.
 
    • 1 — The license was successfully looked up.
    • 0 — The license does not exist.
    • -1 — The request failed due to an error.
Changed:
<
<
  • version (float) — Internal information used by the Manage2 API.
>
>
  • version (float) — Internal information used by the Manage2 API.
 

Examples

Line: 32 to 39
 
Changed:
<
<
Show Hide
<--/twistyPlugin twikiMakeVisibleInline-->

Calling http://manage2.cpanel.net/XMLlookup.cgi?ip=127.0.0.1 in a web browser will produce XML output similar to the following:

>
>
Calling http://manage2.cpanel.net/XMLlookup.cgi?ip=127.0.0.1;all=1 in a web browser will produce XML output similar to the following:
 
%CODE{ lang="html"}%
Changed:
<
<
>
>
5388377 5388378
 %ENDCODE%

Calling the function using the URL above will return XML data by default. To change the output format that will be returned, use either of the following URLs:

  • JSONhttp://manage2.cpanel.net/XMLlookup.cgi?output=json&ip=127.0.0.1
  • YAMLhttp://manage2.cpanel.net/XMLlookup.cgi?output=yaml&ip=127.0.0.1
For more information about each of these output types, visit our Choosing an Output Type documentation.
Deleted:
<
<
<--/twistyPlugin-->
 

Using a Perl module

Deleted:
<
<
Show Hide
<--/twistyPlugin twikiMakeVisibleInline-->
 The following is an example of a Perl module that will call XMLlookup.cgi. You can use this module to pass input variables to a Manage2 API function. You may need to edit the example below to suit your needs.

Line: 65 to 61
  use cPanelLicensing; my $cpl = cPanelLicensing->new(user => $user, pass => $pass);
Changed:
<
<
$cpl->fetchLicenseId( ip=>$ip )
>
>
my $licenses = $cpl->fetchLicenseId(ip => $ip); print "@$licenses\n";
  %ENDCODE%
Changed:
<
<
In this example, $ip is meant to stand for the IP address that corresponds to the license ID you wish to retrieve.
>
>
In this example:
  • $ip is meant to stand for the IP address that corresponds to the license ID you wish to retrieve.
  • $user and $pass are meant to stand for your Manage2 account credentials.
  You can learn more about using a Perl module to call API functions.
Deleted:
<
<
<--/twistyPlugin-->
 

Using a PHP class

Deleted:
<
<
Show Hide
<--/twistyPlugin twikiMakeVisibleInline-->
 The following is an example showing how to call the cPanelLicensing PHP class. You can use this class to pass input variables to the Manage2 API using a few short calls.

Line: 91 to 80
 
%CODE{ lang="php" }% <?php
Deleted:
<
<
 include("cpl.inc.php");
Changed:
<
<
$cpl = new cPanelLicensing("__USERNAME__","__PASSWORD__"); $lisc = $cpl->fetchLicenseId(array( "ip" => $ip ) );
>
>
$cpl = new cPanelLicensing($user, $pass); $licenses = $cpl->fetchLicenseId(array("ip" => $ip));
 ?> %ENDCODE%
Changed:
<
<
In this example, $ip is meant to stand for the IP address that corresponds to the license ID you wish to retrieve.

PICK Remember: __USERNAME__ and __PASSWORD__ are meant to represent the username and password for your Manage2 account.

>
>
In this example:
  • $ip is meant to stand for the IP address that corresponds to the license ID you wish to retrieve.
  • $user and $pass are meant to stand for your Manage2 account credentials.
  You can learn more about using a PHP class to call API functions.
Deleted:
<
<
<--/twistyPlugin-->