partner10.problemKey

Purpose

Marks a key as problem or not problem.

 

Signature

Method name: partner10.problemKey.

 

Parameters

# Type Description

1

struct AuthInfo

client authentication information

2

string

number of a key

3

boolean

whether to suspend (true) or resume (false) the key

 

Returns

Field Type Description

resultCode

int

code for the command execution result (see below)

resultDesc

string

textual description of the command execution result (see below)

keyNumber

string

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

 

Result Codes

resultCode resultDesc

100

<key number> has been successfully marked as problem

100

<key number> has been successfully marked as not problem

110

<key number> is already problem

110

<key number> is already not problem

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

222

License key <key number> is terminated

231

License key not supports changing "problem" flag

300

Internal error, please try after some time

400

Incorrect authorization info format

410

Incorrect key number format: "<key number>"

452

Incorrect object type for this operation

 

XML Examples

Request message

<?xml version='1.0'?>
<methodCall>
  <methodName>partner10.problemKey</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>PLSK.00123456.0000</string>
      </value>
    </param>
    <param>
      <value>
        <boolean>1</boolean>
      </value>
    </param>
  </params>
</methodCall>

Response message

<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>keyNumber</name>
            <value>PLSK.00123456.0000</value>
          </member>
          <member>
            <name>resultCode</name>
            <value>
              <int>100</int>
            </value>
          </member>
          <member>
            <name>resultDesc</name>
            <value>PLSK.00123456.0000 has been successfully marked as problem</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.