partner10.unbindKey

Purpose

Unbinds Key from any IP address.

Signature

Method name: partner10.unbindKey

Parameters

# Type Description

1

struct AuthInfo

requesting party authentication information

2

string

number of a key that need to unbind

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

key number. The key pattern is XXXX.XXXXXXXX.XXXX

Result Codes

resultCode resultDesc

100

Key <key number> was successfully unbound from IP address.

101

Key <key number> is already unbound from IP address.

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

253

This customer account is unconfirmed. No further actions for this customer are allowed.

300

Internal error, please try after some time

400

Incorrect authorization info format

410

Incorrect key number format: "<key number>"

XML Examples

Request message

<methodCall>
  <methodName>partner10.unbindKey</methodName>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>login</name>
            <value>
              <string><em>API_LOGIN</em></string>
            </value>
          </member>
          <member>
            <name>password</name>
            <value>
              <string><em>API_PASSWORD</em></string>
            </value>
          </member>
        </struct>
      </value>
    </param>
    <param>
      <value>
        <string>PLSK.00123456.0000</string>
      </value>
    </param>
  </params>
</methodCall>

Response message

<?xml version="1.0"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>resultCode</name>
            <value>
              <int>100</int>
            </value>
          </member>
          <member>
            <name>resultDesc</name>
            <value>Key PLSK.00123456.0000 was successfully unbound from IP address.</value>
          </member>
          <member>
            <name>keyNumber</name>
            <value>PLSK.00123456.0000</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.