Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
GetDomain SOAP Command

Get information about a domain

Authorization token required true
Admin Authorization token required true

GetDomainRequest

    <GetDomainRequest [applyConfig="{apply-config} (0|1)"] [attrs="{request-attrs}"]> ## GetDomainRequest
        <domain [by="{domain-selector-by} (id|name|virtualHostname|krb5Realm|foreignName)"]>{key}</domain> ## DomainSelector
    </GetDomainRequest>

The following table describes elements and attributes you can define within a <GetDomainRequest> element:

XPath Required / Optional Description
@applyConfig Optional (0 or 1) Type:0|1
If {apply-config} is 1 (true), then certain unset attrs on a domain will get their values from the global config.
if {apply-config} is 0 (false), then only attributes directly set on the domain will be returned
@attrs Optional (0 or 1) Type:String
Comma separated list of attributes
/domain Optional (0 or 1) Type:{key}
Domain
Description for element text content:The key used to identify the domain. Meaning determined by {domain-selector-by}
/domain@by Optional (0 or 1) Type:id|name|virtualHostname|krb5Realm|foreignName
Select the meaning of {domain-selector-key}

GetDomainResponse

    <GetDomainResponse> ## GetDomainResponse
        <domain name="{name}" id="{id}"> ## DomainInfo
            (<a n="{key}" /> ## Attr)*
         </domain>
    </GetDomainResponse>

The following table describes elements and attributes you can define within a <GetDomainResponse> element:

XPath Required / Optional Description
/domain Optional (0 or 1) Information about domain
/domain@name Required (only 1) Type:String
Name
/domain@id Required (only 1) Type:String
ID
/domain/a Optional (0 or more) Attributes
/domain/a@n Required (only 1) Type:String
Key