Manage2 API Function - Update Active License Metadata
Last modified: June 9, 2021
Description
This function updates an active license’s metadata.
Examples
Browser-based calls
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
cPanelLicensing PHP Class
|
|
cPanelLicensing Perl Module
|
|
Output (XML)
<XMLupdateActiveLicenseMetadata reason="Updated license metadata" status="1" />
Output (JSON)
|
|
Output (YAML)
|
|
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:
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 |