API License Module createPleskLicenseRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 11:53, 5 September 2018

License Module > Create License

Module	License
Command name	createPleskLicenseRequest
Use	Order a new license
Input	title text comment text items period = 1, 12, 24 ipAddressBinding ipv4/ipv6 address restrictIPBinding true \| false
Output	id

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('createLicenseRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
      'productId' => 7,
      'title' => 'Linux server APOLLO',
      'options' => array(
        'version' => 12,
        'type' => 'webHost',
        'period' => 12,
        'langPacks' => 1,
        'pack' => 'POWERPACK',
        'sites' => 30,
        'virtualization' => 'unified'
      )
  ));

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>
  <createLicenseRequest>
    <productId>7</productId>
    <title>Linux server APOLLO</title>
    <options>
      <version>12</version>
      <type>webHost</type>
      <period>12</period>
      <langPacks>1</langPacks>
      <pack>POWERPACK</pack>
      <sites>30</sites>
      <virtualization>unified</virtualization>
    </options>
  </createLicenseRequest>
</openXML>

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

@@ Line 1: / Line 1: @@
-==Module Licenses > Create License==
+==License Module > Create License==
 {| border="1" cellpadding="4"
 |- style="background-color:#BBBBBB;"
 |'''Module'''
-|Licenses
+|License
 |- style="background-color:#EEEEEE;"
 |'''Command name'''
-|createLicenseRequest
+| createPleskLicenseRequest
 |-
 |'''Use'''
@@ Line 13: / Line 13: @@
 |'''Input'''
 |
-*'''title'''
+*'''title''' ''text''
-*comment
+*'''comment''' ''text''
-*'''[[API Format License Options|productId]]'''
+*'''[[API Format License Options#License_items_for_Plesk|items]]'''
-*'''[[API Format License Options|options]]'''
+*'''period''' = ''1, 12, 24''
+*'''ipAddressBinding''' ''ipv4/ipv6 address''
+*'''restrictIPBinding''' ''true | false''
 |- style="vertical-align:top;"
 |'''Output'''