partner10.renewKey

Purpose

Renews an existing key.

 

Signature

Method name: partner10.renewKey

 

Parameters

# Type Description

1

struct AuthInfo

client authentication information

2

string

number of a key to upgrade

 

Returns

Field Type Description

resultCode

int

code for command execution result (see below)

resultDesc

string

textual description of command execution result (see below)

keyNumber

string

number of renewed key in format of PLSK.XXXXXXXX.XXXX

expirationDate

dateTime.iso8601

key expiration date

updateDate

dateTime.iso8601

key update date. If there is no update date for the license - will absent

productKey

string

Product activation code. If there is no product activation code for the license - will absent

 

Result Codes

resultCode resultDesc

100

License expiration date for key <key number> has been set to <date>

200

Client authorization failed

201

Access to this method is denied

202

Access to this object is denied

220

Key <key number> is not found

221

License key <key number> is marked as problem

222

License key <key number> is terminated

250

Client with login <login> is not found

285

This key can't be renewed

286

Renewing key is failed

287

Failed to complete remote operation with product <product family>

300

Internal error, please try after some time

400

Incorrect authorization info format

410

Incorrect key number format: "<key number>"

XML Examples

Request

<methodCall>
  <methodName>partner10.renewKey</methodName>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>login</name>
            <value>
              <string>LOGIN</string>
            </value>
          </member>
          <member>
            <name>password</name>
            <value>
              <string>PASSWORD</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
    <param>
      <value>
        <string>DRW.00012345.0000</string>
      </value>
    </param>
  </params>
</methodCall>

Response

<?xml version="1.0"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>resultCode</name>
            <value>
              <int>100</int>
            </value>
          </member>
          <member>
            <name>resultDesc</name>
            <value>License expiration date for key DRW.00012345.0000 has been set to 2009.12.10</value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>
 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.