Manage2 API Function - Update Active License Metadata

Last modified: June 9, 2021


Description

This function updates an active license’s metadata.

Examples

XML

https://manage2.cpanel.net/XMLupdateActiveLicenseMetadata.cgi?liscid=62630487&external_notes=this%20is%20a%20note

JSON

https://manage2.cpanel.net/XMLupdateActiveLicenseMetadata.cgi?output=json&liscid=62630487&external_notes=this%20is%20a%20note

YAML

https://manage2.cpanel.net/XMLupdateActiveLicenseMetadata.cgi?output=yaml&liscid=62630487&external_notes=this%20is%20a%20note

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<?php
include("cpl.inc.php");
$cpl = new cPanelLicensing("[email protected]", "123456luggage");
$ref = $cpl->request(
    "XMLupdateActiveLicenseMetadata.cgi", [
        "liscid" => 62630487,
        "external_notes" => "this is a note",
    ]
);
?>

1
2
3
4
5
6
7
use cPanelLicensing;
my $cpl = cPanelLicensing->new(user => "username\@example.com", pass => "123456luggage");
my $ref = $cpl->request(
    "/XMLupdateActiveLicenseMetadata.cgi",
    liscid => 62630487,
    external_notes => "this is a note",
);

<XMLupdateActiveLicenseMetadata reason="Updated license metadata" status="1" />

1
2
3
4
{
   "status":1,
   "reason":"Updated license metadata"
}

1
2
3
---
status: 1
reason: Updated license metadata

Parameters

This function accepts the following parameters:

Parameter Type Description Example
liscid number Required
The license ID number.
62630487
external_notes string Required
Additional information about the license, up to 64 characters long:
  • If the parameter’s value exceeds 64 characters, this function will return an error.
  • This parameter accepts an empty string value ('').
Important:
This parameter overwrites any existing external_notes values with the new value.
this is a note

Returns

This function returns the following values:

Return Type Description Example
reason string Information about the license activation. Updated license metadata.
status Boolean Whether the function succeeded:
  • 1 — Success.
  • 0 — Failure.
1

Additional Documentation