The get_additional_key operation retrieves data of additional key installed on the server, such as the key name and number, key expiration date and usage (whether the key is active or not), key content and other properties.
A request XML packet retrieving additional key data contains the get_additional_key operation node:
<packet version="1.4.2.0">
<server>
<get_additional_key>
...
</get_additional_key>
</server>
</packet>
The get_additional_key node is presented by complex type GetAdditionalKeyType (server_input.xsd
) and structured as follows:
server_input.xsd
).
To retrieve data of all additional keys installed on the server, use empty filter node, or omit it at all and send packet with empty get_additional_key node:
<packet version="1.4.2.0">
<server>
<get_additional_key>
<filter/>
</get_additional_key>
</server>
</packet>
or
<packet version="1.4.2.0">
<server>
<get_additional_key/>
</server>
</packet>
The get_additional_key node of the response packet is structured as follows:
server_output.xsd
).common.xsd
). Allowed values: ok | error.server_output.xsd
). The node structure is the following:server_output.xsd
).This packet retrieves data of the additional license key with number PLSK002694000000 and name antivir-drweb-4, which is the license key allowing using such additional Plesk feature as DrWeb Antivirus.
<packet version="1.4.2.0">
<server>
<get_additional_key>
<filter>
<name>PLSK002694000000/antivir-drweb-4</name>
</filter>
</get_additional_key>
</server>
</packet>
Response:
<packet version="1.4.2.0">
<server>
<get_additional_key>
<result>
<status>ok</status>
<key_info>
<number>PLSK002694000000</number>
<name>PLSK002694000000/antivir-drweb-4</name>
<active>true</active>
<license_update_date>20060506</license_update_date>
<lim_date>20060511</lim_date>
<content>IyEvYmluL3NoCgpQUk9EVUNUX1JPT1RfRD1gYXdrICckMSB+IC9QUk9EVUNUX1JPT1RfRC97IHByaW50ICQyfScgL2V0Yy9wc2EvcHNhLmNvbmZgCmlmIHRlc3QgLXogIiRQUk9EVUNUX1JPT1RfRCI7IHRoZW4KZWNobyAiUGxlc2sgbm90IGRldGVjdGVkIgpleGl0IDEKZmkKIiRQUk9EVUNUX1JPT1RfRC9hZG1pbi9zYmluL2tleW1uZyIgLS1pbnN0YWxsLWFkZGl0aW9uYWwgLS1zb3VyY2UtZmlsZT0iJDAiIC0tc2tpcD01CmV4aXQgJD8KCi0tLS0tQkVHSU4gUExFU0sgQURESVRJT05BTCBLRVktLS0tLQprZXlfbnVtYmVyPSdQTFNLMDAyNjk0NzMwMDAwJwprZXk9J095QkVjbGRsWWpNeUlIWTBMakUyS3lCTFpYa2dSbWxzWlEwS095QkVieUJ1YjNRZ1pXUnBkQ0VOQ2cwS095QWVIeDRmSGg4ZUh4NGZIaDhlSHg0ZkhoOGVIeDRmSGcwS0RRcGJTMlY1WFEwS1ZsSTlNREF3TURBd01EQXdNQTBLUVZBOU1EQXdNRFV5TkRNeU1BMEtRMUk5TVRFME5EY3pPVEl6T1EwS1JWZzlNVEUwTnpNek1USXpPUTBLVTBVOU1URTBOek16TVRJek9RMEtWbVZ5YzJsdmJqMUJiR3dOQ2tGd2NHeHBZMkYwYVc5dWN6MUVjbGRsWWxWdWFYZ3NUV0ZwYkVSaFpXMXZibFZ1YVhnTkNrTnlaV0YwWldROU1qQXdOaTB3TkMweE1TQW9NRGM2TURjcElGVlVRdzBLUlhod2FYSmxjejB5TURBMkxUQTFMVEV4SUNnd056b3dOeWtnVlZSRERRcFRkV0p6WTNKcGNIUnBiMjVGZUhCcGNtVnpQVEl3TURZdE1EVXRN</content>
<property>
<name>name</name>
<value>antivir-drweb-4</value>
</property>
<property>
<name>filename</name>
<value>/etc/psa/key.d/keyyV1LsN</value>
</property>
<property>
<name>key</name>
<value>OyBEcldlYjMyIHY0LjE2KyBLZXkgRmlsZQ0KOyBEbyBub3QgZWRpdCENCg0KOyAeHx4fHh8eHx4fHh8eHx4fHh8eHx4fHg0KDQpbS2V5XQ0KVlI9MDAwMDAwMDAaW9ucz1EcldlYlVuaXgsTWFpbERhZW1vblVuaXgNCkNyZWF0ZWQ9MjAwNi0wNC0xMSAoMDc6MDcpIFVUQw0KRXhwaXJlcz0yMDA2LTA1LTExICgwNzowNykgVVRDDQpTdWJzY3JpcHRpb25FeHBpcmVzPTIwMDYtMDUtMTEgKDA3OjA3KSBVVEMNCg0KW0RlYWxlcl0NCk51bWJlcj0wMDEwMDAwMDAwDQpOYW1lPVBsZXNrDQpHVj00MzIwMDUNClAxPTg2MUYwRUZBNTRGMjEwMzFBRUNCODFBRUY4N0E3QTkyRUVEMzRCNTdFNzJERjk5MjNBNkYyRjZBRDY3MM3RUI0OTM4RUZFMjNGQTM4NkMwNzU5MDYzOTRGOTg1Qg0KDQpbVXNlcl0NCk51bWJlcj0wMTAwNTExNTgwDQpOYW1lPUFsZXhhbmRlciBLcmFzbm92IChTVy1Tb2Z0LCBJbmMpIChURVNUKQ0KQ29tcHV0ZXJzPTENCkdWPTQzMzAwMw0KDQpbU2V0dGluZ3NdDQpNYWlsU2VydmVyPVllcw0KRmlsZVNlcnZlcj1Obw0KSW5ldEdhdGV3YXk9Tm8NCkVtYWlsQWRkcmVzc2VzPVVubGltaXRlZA0KVHJhZmZpY0xpbWl0PVVubGltaXRlZA0KDQpbU2lnbmF0dXJlXQ0KVmFsdWU9NDdFOTg3RDQwMEU1NzFBNjM5MkFCRDVFOUQ5Qjc5NTgzRkMzMTQ2MzEzMTlGODEzOEFBQjU4QTJCQ0Q4OEM0OUMyNzIxM0NFQTVBREMyMEUNCg==</value>
</property>
</key_info>
</result>
</get_additional_key>
</server>
</packet>
This packet retrieves data of all additional license keys installed on server:
<packet version="1.4.2.0">
<server>
<get_additional_key/>
</server>
</packet>
Response (if no additional keys are installed):
<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.4.2.0">
<server>
<get_additional_key>
<result>
<status>ok</status>
</result>
</get_additional_key>
</server>
</packet>