API License Module modifyPleskLicenseRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
 
(2 intermediate revisions not shown)
Line 1: Line 1:
-
==Module Licenses > Edit License==
+
==License Module > Edit License==
{| border="1" cellpadding="4"
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
Line 6: Line 6:
|- style="background-color:#EEEEEE;"
|- style="background-color:#EEEEEE;"
|'''Command name'''
|'''Command name'''
-
|editLicenseRequest
+
|modifyPleskLicenseRequest
|-
|-
|'''Use'''
|'''Use'''
Line 13: Line 13:
|'''Input'''
|'''Input'''
|
|
-
*'''id'''
+
*'''title''' ''text''
-
*'''title'''
+
*'''comment''' ''text''
-
*comment
+
*'''[[API Format License Options##License_items_for_Plesk|items]]''' ''License Items for Plesk''
 +
*'''[[API Format License Options#License_features|features]]''' ''Features for Plesk''
 +
*'''[[API Format License Options#License_features|attachedKeys]]''' ''Third-party extension keys''
 +
*'''parentKeyId''' ''key number of a parent license(optional)''
 +
*'''period''' = ''1, 12, 24''
 +
*'''ipAddressBinding''' ''ipv4/ipv6 address''
 +
*'''restrictIPBinding''' ''true | false''
 +
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 25: Line 32:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('editLicenseRequest')
+
  $request->setCommand('modifyPleskLicenseRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
Line 41: Line 48:
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <editLicenseRequest>
+
   <modifyPleskLicenseRequest>
     <id>1446</id>
     <id>1446</id>
     <title>Linux server ARTEMIS</title>
     <title>Linux server ARTEMIS</title>
     <comment>Old server name: APOLLO</comment>
     <comment>Old server name: APOLLO</comment>
-
   </editLicenseRequest>
+
   </modifyPleskLicenseRequest>
  </openXML>
  </openXML>

Current revision as of 08:14, 11 September 2018

Contents

License Module > Edit License

Module Licenses
Command name modifyPleskLicenseRequest
Use Change title or comments of ordered license
Input
  • title text
  • comment text
  • 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(
    'id' => 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>
    <id>1446</id>
    <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>
Views
Personal tools