Carbonio SOAP API Reference 23.11.0_ZEXTRAS

Command

Service: zimbraAdmin

Command: GetServer
Namespace: urn:zimbraAdmin
Description: Get Server

Properties:

Authorization token required	true
Admin Authorization token required	true

    <GetServerRequest [applyConfig="{apply-config} (0|1)"] [attrs="{request-attrs}"]> ## GetServerRequest
        <server [by="{server-by} (id | name | serviceHostname)"]>{key}</server> ## ServerSelector
    </GetServerRequest>

elements and attributes you can define within a <GetServerRequest> 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 server will get their values from the global config.
if {apply-config} is 0 (false), then only attributes directly set on the server will be returned

@attrs Optional (0 or 1) Type: String
Comma separated list of attributes

/server

Optional (0 or 1)

Type: {key}
Server
Description for element text content:Key for choosing server

{server-by}="id"	Use server's zimbraId as the Key
{server-by}="name"	Use name of the server as the Key
{server-by}="serviceHostname"	Use server's value for attr zimbraServiceHostname as the Key

/server@by Optional (0 or 1) Type: id | name | serviceHostname
Selects the meaning of {server-key}

GetServerResponse

    <GetServerResponse> ## GetServerResponse
        <server name="{name}" id="{id}"> ## ServerInfo
            (<a n="{key}" /> ## Attr)*
         </server>
    </GetServerResponse>

elements and attributes you can define within a <GetServerResponse> element:

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