• Please be aware: Kaspersky Anti-Virus has been deprecated
    With the upgrade to Plesk Obsidian 18.0.64, "Kaspersky Anti-Virus for Servers" will be automatically removed from the servers it is installed on. We recommend that you migrate to Sophos Anti-Virus for Servers.
  • The Horde webmail has been deprecated. Its complete removal is scheduled for April 2025. For details and recommended actions, see the Feature and Deprecation Plan.
  • We’re working on enhancing the Monitoring feature in Plesk, and we could really use your expertise! If you’re open to sharing your experiences with server and website monitoring or providing feedback, we’d love to have a one-hour online meeting with you.

Resolved [XML RPC-API] Domains description not return when set in Panel

Kaspar

API expert
Plesk Guru
Username:

TITLE


[XML RPC-API] Domains description not return when set in Panel

PRODUCT, VERSION, OPERATING SYSTEM, ARCHITECTURE

CenOS 7.9
Plesk 18.0.49

PROBLEM DESCRIPTION

A description for a domain can be set in Plesk, only visible to administrators (if I am not mistaken).

nIUswRC.png


According to the API RCP documentation the domain description can be returned with the use of the gen_info descriptor. However the description value always returns empty.

STEPS TO REPRODUCE

1) Setup a domain in Plesk
2) Add a description to the domain
3) Make a API call with the gen_info descriptor for the domain. For example:
XML:
<packet>
<site>
    <get>
       <filter>
            <name>example.com</name>
       </filter>
       <dataset>
            <gen_info/>
       </dataset>
    </get>
</site>
</packet>

ACTUAL RESULT

Notice how the description value returns without a value.
XML:
<?xml version="1.0" encoding="UTF-8"?>
<packet version="1.6.9.1">
  <site>
    <get>
      <result>
        <status>ok</status>
        <filter-id>example.com</filter-id>
        <id>365</id>
        <data>
          <gen_info>
            <cr_date>2022-12-19</cr_date>
            <name>example.com</name>
            <ascii-name>example.com</ascii-name>
            <status>0</status>
            <real_size>751788032</real_size>
            <dns_ip_address>123.123.123.123</dns_ip_address>
            <dns_ip_address>2020:2020:2020:2020::20</dns_ip_address>
            <htype>vrt_hst</htype>
            <guid>6d0f9eec-9190-4634-b8c8-11e7dfee571d</guid>
            <webspace-guid>6d0f9eec-9190-4634-b8c8-11e7dfee571d</webspace-guid>
            <sb-site-uuid/>
            <webspace-id>365</webspace-id>
            <description/>
          </gen_info>
        </data>
      </result>
    </get>
  </site>
</packet>

EXPECTED RESULT

The description is actually shown in the returned result.

ANY ADDITIONAL INFORMATION

(DID NOT ANSWER QUESTION)

YOUR EXPECTATIONS FROM PLESK SERVICE TEAM

Confirm bug
 
Last edited:
My bad. I've mistaken the clients description for a domain with the admins description. The gen_info descriptor on the XML API actually only returns the clients description. This works without any issue. So this bug report can be closed and ignored.
 
Back
Top