partner10.getKeysInfoByIP

Purpose

Retrieves information about keys, which are bound to specified IP address.

 

Signature

Method name: partner10.getKeysInfoByIP

 

Parameters

# Type Description

1

struct AuthInfo

client authentication information

2

String

IP address

 

Returns

Field Type Description

resultCode

int

code for command execution result (see below)

resultDesc

string

textual description of command execution result (see below)

keysInfo

array (struct KeyDetails)

detail info for keys, which bound to given IP address, can be absent if no keys found

 

Result Codes

resultCode resultDesc

100

Keys info for <IP address> IP address returned successfully

101

No keys found, which are bound to given <IP address> IP address

200

Client authorization failed

201

Access to this method is denied

300

Internal error, please try after some time

400

Incorrect authorization info format

405

Incorrect IP address format

 

XML Examples

Request message

<?xml version='1.0'?>
<methodCall>
   <methodName>partner10.getKeysInfoByIP</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>192.168.0.1</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>Keys info for 192.168.0.1 IP address returned
            successfully</value>
          </member>
          <member>
            <name>keysInfo</name>
            <value>
              <array>
                <data>
                  <value>
                    <struct>
                      <member>
                        <name>problem</name>
                        <value>
                          <boolean>0</boolean>
                        </value>
                      </member>
                      <member>
                        <name>apiKeyType</name>
                        <value>PLESK_8</value>
                      </member>
                      <member>
                         <name>productConfigurationId</name>
                         <value>90691</value>
                      </member>
                      <member>
                        <name>features</name>
                        <value>
                          <array>
                            <data>
                              <value>
                                <struct>
                                  <member>
                                    <name>apiName</name>
                                    <value>100_DOMAINS</value>
                                  </member>
                                  <member>
                                    <name>name</name>
                                    <value>100 Domains w/1 yr SUS
                                    (Purchased)</value>
                                  </member>
                                </struct>
                              </value>
                            </data>
                          </array>
                        </value>
                      </member>
                      <member>
                        <name>expirationDate</name>
                        <value>
                          <dateTime.iso8601>
                          20080906T00:00:00</dateTime.iso8601>
                        </value>
                      </member>
                      <member>
                        <name>additionalKeys</name>
                        <value>
                          <array>
                            <data>
                              <value>
                                <struct>
                                  <member>
                                    <name>problem</name>
                                    <value>
                                      <boolean>0</boolean>
                                    </value>
                                  </member>
                                  <member>
                                    <name>apiKeyType</name>
                                    <value>SITEBUILDER_30</value>
                                  </member>
                                  <member>
                                    <name>features</name>
                                    <value>
                                      <array>
                                        <data>
                                          <value>
                                            <struct>
                                              <member>
                                                <name>
                                                apiName</name>
                                                <value>
                                                500_SITES</value>
                                              </member>
                                              <member>
                                                <name>name</name>
                                                <value>500 Sites
                                                w/1 yr SUS
                                                (Purchased)</value>
                                              </member>
                                            </struct>
                                          </value>
                                        </data>
                                      </array>
                                    </value>
                                  </member>
                                  <member>
                                    <name>expirationDate</name>
                                    <value>
                                      <dateTime.iso8601>
                                      20080706T00:00:00</dateTime.iso8601>
                                    </value>
                                  </member>
                                  <member>
                                    <name>additionalKeys</name>
                                    <value>
                                      <array>
                                        <data></data>
                                      </array>
                                    </value>
                                  </member>
                                  <member>
                                    <name>type</name>
                                    <value>ADDITIONAL</value>
                                  </member>
                                  <member>
                                    <name>keyType</name>
                                    <value>SiteBuilder 3.0 for
                                    Unix/Linux (Purchased)</value>
                                  </member>
                                  <member>
                                    <name>susAndSupportInfo</name>
                                    <value>
                                      <array>
                                        <data>
                                          <value>
                                            <struct>
                                              <member>
                                                <name>
                                                expiration</name>
                                                <value>
                                                  <dateTime.iso8601>
                                                  20090527T00:00:00</dateTime.iso8601>
                                                </value>
                                              </member>
                                              <member>
                                                <name>name</name>
                                                <value>SUS
                                                Present</value>
                                              </member>
                                            </struct>
                                          </value>
                                        </data>
                                      </array>
                                    </value>
                                  </member>
                                  <member>
                                    <name>billingType</name>
                                    <value>PURCHASE</value>
                                  </member>
                                  <member>
                                    <name>properties</name>
                                    <value>
                                      <struct></struct>
                                    </value>
                                  </member>
                                  <member>
                                    <name>productFamily</name>
                                    <value>sb</value>
                                  </member>
                                  <member>
                                    <name>boundIPAddress</name>
                                    <value></value>
                                  </member>
                                  <member>
                                    <name>createDate</name>
                                    <value>
                                      <dateTime.iso8601>
                                      20080527T05:33:54</dateTime.iso8601>
                                    </value>
                                  </member>
                                  <member>
                                    <name>keyNumber</name>
                                    <value>SB.00123456.0001</value>
                                  </member>
                                  <member>
                                    <name>clientId</name>
                                    <value>
                                      <int>CLIENT_ID</int>
                                    </value>
                                  </member>
                                  <member>
                                    <name>terminated</name>
                                    <value>
                                      <boolean>0</boolean>
                                    </value>
                                  </member>
                                </struct>
                              </value>
                            </data>
                          </array>
                        </value>
                      </member>
                      <member>
                        <name>type</name>
                        <value>MAIN</value>
                      </member>
                      <member>
                        <name>keyType</name>
                        <value>Plesk Control Panel 8.x
                        (Purchased)</value>
                      </member>
                      <member>
                        <name>susAndSupportInfo</name>
                        <value>
                          <array>
                            <data>
                              <value>
                                <struct>
                                  <member>
                                    <name>expiration</name>
                                    <value>
                                      <dateTime.iso8601>
                                      20090527T00:00:00</dateTime.iso8601>
                                    </value>
                                  </member>
                                  <member>
                                    <name>name</name>
                                    <value>SUS Present</value>
                                  </member>
                                </struct>
                              </value>
                            </data>
                          </array>
                        </value>
                      </member>
                      <member>
                        <name>billingType</name>
                        <value>PURCHASE</value>
                      </member>
                      <member>
                        <name>properties</name>
                        <value>
                          <struct>
                            <member>
                              <name>MLS</name>
                              <value>0</value>
                            </member>
                          </struct>
                        </value>
                      </member>
                      <member>
                        <name>productFamily</name>
                        <value>plesk</value>
                      </member>
                      <member>
                        <name>boundIPAddress</name>
                        <value>192.168.0.1</value>
                      </member>
                      <member>
                        <name>createDate</name>
                        <value>
                          <dateTime.iso8601>
                          20080527T05:33:34</dateTime.iso8601>
                        </value>
                      </member>
                      <member>
                        <name>keyNumber</name>
                        <value>PLSK.00123456.0000</value>
                      </member>
                      <member>
                        <name>clientId</name>
                        <value>
                          <int>CLIENT_ID</int>
                        </value>
                      </member>
                      <member>
                        <name>terminated</name>
                        <value>
                          <boolean>0</boolean>
                        </value>
                      </member>
                    </struct>
                  </value>
                </data>
              </array>
            </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.