Carbonio SOAP API Reference 24.9.5_ZEXTRAS

Service: zimbraAdmin

Command: ContactBackup
Namespace: urn:zimbraAdmin
Description: start/stop contact backup

Properties:

Authorization token required	true
Admin Authorization token required	true

    <ContactBackupRequest op="{op} (start | stop)"> ## ContactBackupRequest
        <servers>
            (<server [by="{server-by} (id | name | serviceHostname)"]>{key}</server> ## ServerSelector)+
        </servers>
    </ContactBackupRequest>

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

XPath Required / Optional Description

@op Required (only 1) Type: start | stop
op can be either start or stop

/servers Required (only 1)

/servers/server

Required (1 or more)

Type: {key}
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

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

ContactBackupResponse

    <ContactBackupResponse> ## ContactBackupResponse
        <servers>
            (<server name="..." status="(started | error | stopped)" /> ## ContactBackupServer)+
        </servers>
    </ContactBackupResponse>

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

XPath	Required / Optional	Description
/servers	Required (only 1)
/servers/server	Required (1 or more)
/servers/server@name	Required (only 1)	Type: String
/servers/server@status	Required (only 1)	Type: started \| error \| stopped