List of Domains

The information about Plesk updates is held by the admin-domain-list node, which is presented by complex type domainListOutputType (domain_list.xsd). The node is structured as follows:

server_admin-domain-list_output

  • The id node is required. It holds the ID of the domain. Data type: id_type.
  • The name node is required. It holds the domain name. Data type: string.
  • The ascii-name node is required. It holds the domain name in ASCII characters. Data type: string.
  • The type node is required. It holds the domain type (domain, subdomain, alias). Data type: string.
  • The main node is required. It indicates whether the domain is the main domain on a webspace. Data type: boolean.
  • The guid node is required. It holds the unique identifier of the domain. Data type: string.
  • The external-id node is required. It holds the identifier of the domain in an external system. Data type: string.
  • The parent-id node is optional. It holds the ID of the parent domain to which the subdomain belongs. Data type: id_type.
  • The domain-id node is optional. It holds the ID of the domain to which the domain alias is related. Data type: id_type.

A response packet received from server can look as follows:

<packet>
  <server>
    <get>
      <result>
        <status>ok</status>
        <admin-domain-list>
          <domain>
            <id>43</id>
            <name>adminsub.com</name>
            <ascii-name>adminsub.com</ascii-name>
            <type>domain</type>
            <main>true</main>
            <guid>7834463f-03a1-48fc-8cbe-4515f6918211</guid>
            <external-id/>
          </domain>
          <domain>
            <id>44</id>
            <name>sub1.adminsub.com</name>
            <ascii-name>sub1.adminsub.com</ascii-name>
            <type>subdomain</type>
            <main>false</main>
            <guid>2f5ca57d-191e-4402-a1b7-7e9023c5bea7</guid>
            <external-id/>
            <parent-id>43</parent-id>
          </domain>
          <domain>
            <id>8</id>
            <name>subadmin.com</name>
            <ascii-name>subadmin.com</ascii-name>
            <type>alias</type>
            <main>false</main>
            <guid>7834463f-03a1-48fc-8cbe-4515f6918211</guid>
            <external-id/>
            <domain-id>43</domain-id>
          </domain>
        </admin-domain-list>
      </result>
    </get>
  </server>
</packet>
 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.