API License Module modifyPleskLicenseRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 11:19, 5 December 2025

License Module > Edit License

Module	Licenses
Command name	modifyPleskLicenseRequest
Use	Change title or comments of ordered license
Input	title text keyId keyId comment text (mandatory) items License Items for Plesk features Features for Plesk attachedKeys Third-party extension keys parentKeyId key number of a parent license(optional) period = 1, 12, 24 ipAddressBinding ipv4/ipv6 address restrictIPBinding true \| false
Output	id

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('modifyPleskLicenseRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'keyId' => 1446,
    'title' => 'Linux server ARTEMIS',
    'comment' => 'Old server name: APOLLO'
  ));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <modifyPleskLicenseRequest>
    <keyId>1446</keyId>
    <title>Linux server ARTEMIS</title>
    <comment>Old server name: APOLLO</comment>
  </modifyPleskLicenseRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>1</data>
  </reply>
</openXML>

@@ Line 14: / Line 14: @@
 |
 *'''title''' ''text''
-*'''comment''' ''text''
+*'''keyId''' ''keyId''
+*'''comment''' ''text'' ''(mandatory)''
 *'''[[API Format License Options##License_items_for_Plesk|items]]''' ''License Items for Plesk''
 *'''[[API Format License Options#License_features|features]]''' ''Features for Plesk''
@@ Line 35: / Line 36: @@
     ->setAuth(array('username' => 'username', 'password' => 'password'))
     ->setArgs(array(
-      'id' => 1446,
+      'keyId' => 1446,
       'title' => 'Linux server ARTEMIS',
       'comment' => 'Old server name: APOLLO'
@@ Line 49: / Line 50: @@
     </credentials>
     <modifyPleskLicenseRequest>
-      <id>1446</id>
+      <keyId>1446</keyId>
       <title>Linux server ARTEMIS</title>
       <comment>Old server name: APOLLO</comment>