Mozy Admin Console API

Reference Manual Version 0.1.40

Contents
Preface: Preface..........................................................................................v
Change Control...............................................................................................................7

Chapter 1: Overview...................................................................................9
Resources.....................................................................................................................................................9 WSDL Files Download................................................................................................................................10 Assumptions...............................................................................................................................................10 Adding an IP Address to the API Whitelist..................................................................................................10

Chapter 2: Partner API..............................................................................13
Partner Partner Partner Partner Partner Partner Partner Partner Partner PartnerFindStruct...........................................................................................................................13 PartnerDetailStruct.........................................................................................................................15 AdminStruct...................................................................................................................................15 PartnerStruct..................................................................................................................................17 PartnerResultStruct........................................................................................................................18 Get.................................................................................................................................................19 Create............................................................................................................................................21 Update...........................................................................................................................................23 Delete.............................................................................................................................................24

Chapter 3: Admin API...............................................................................27
Admin Admin Admin Admin Admin Admin Admin Admin AdminDetailStruct............................................................................................................................27 AdminFindStruct..............................................................................................................................28 AdminResultStruct...........................................................................................................................29 AdminStruct.....................................................................................................................................30 Get...................................................................................................................................................31 Create..............................................................................................................................................33 Update.............................................................................................................................................34 Delete..............................................................................................................................................35

Chapter 4: User Group API......................................................................37
User User User User User User User User User Group UserGroupQuotaStruct...........................................................................................................37 Group UserGroupStruct.....................................................................................................................38 Group UserGroupDetailStruct............................................................................................................39 Group UserGroupFindStruct..............................................................................................................39 Group UserGroupResultStruct...........................................................................................................40 Group Get..........................................................................................................................................41 Group Create.....................................................................................................................................43 Group Update.....................................................................................................................................44 Group Delete......................................................................................................................................45

Chapter 5: User API..................................................................................47
User User User User User User User User UserDetailStruct.................................................................................................................................47 UserFindStruct...................................................................................................................................48 UserResultStruct................................................................................................................................49 UserStruct..........................................................................................................................................50 Get.....................................................................................................................................................51 Create................................................................................................................................................52 Update................................................................................................................................................53 Delete.................................................................................................................................................55

Chapter 6: Machine API............................................................................57
iii

Machine Machine Machine Machine Machine Machine Machine Machine

MachineResultStruct....................................................................................................................57 MachineStruct..............................................................................................................................58 MachineDetailStruct.....................................................................................................................59 MachineFindStruct.......................................................................................................................60 Get...............................................................................................................................................61 Create..........................................................................................................................................63 Update..........................................................................................................................................64 Delete...........................................................................................................................................66

Chapter 7: Resource API..........................................................................69
Resource Resource Resource Resource Resource Resource Resource Resource Resource Resource LicenseStruct..............................................................................................................................69 LicenseFindStruct.......................................................................................................................70 ResourceStruct...........................................................................................................................71 LicenseResultStruct...................................................................................................................72 GetResources............................................................................................................................73 GetLicenses...............................................................................................................................74 Provision.....................................................................................................................................75 UpdateLicenses..........................................................................................................................76 Release......................................................................................................................................78 Transfer.......................................................................................................................................79

Chapter 8: Restore APi.............................................................................81
Restore Restore Restore Restore RestoreResultStruct......................................................................................................................81 RestoreStruct................................................................................................................................82 RestoreFindStruct.........................................................................................................................83 Get................................................................................................................................................84

Chapter 9: Email API.................................................................................87
Email Deliver...............................................................................................................................................87

iv

Mozy Admin Console API

or transmitted in any form or any means electronic or mechanical. stored in a retrieval system. including photocopying and recording for any purpose other than the purchaser's personal use without the express written permission of Decho Corporation. Decho Corporation 615 2nd Ave. All rights reserved.com v . Suite 280 Seattle.. Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement or nondisclosure agreement.decho. All other trademarks used herein are the property of their respective owners. No part of this publication may be reproduced. WA 98104 http://www. The software may be used or copied only in accordance with the terms of those agreements.Preface © 2009 Decho Corporation.

.

40 Updates Assumptions WSDL Download Resource LicenseStruct Resource UpdateLicenses User Group Create User Group Update Machine Create Machine Update Resource UpdateLicenses Updated the default namespace location for the APIs. Added external_id.1. Added -1 for unlimited quota. and expires_at elements. Added -1 for unlimited quota.40 release. 7 .1.Change Control The following table tacks all changes to the Admin Console API documentation: Change Description Admin Console 0. Added -1 for unlimited quota. Added -1 for unlimited quota. Added -1 for unlimited quota. Added expires_at and clear_expires_at elements. Updated the URL of the WSDL files to match the 0. quota_desired.

.

see the following links: • SOAP: • Part 0 • Part 1 • Part 2 • XML Schema Information: • Overview • Schema 0 • Schema 1 • Schema 2 • http://www.org/XML/ • http://www. SOAP. For additional information on the items above. Topics: • • • • Resources WSDL Files Download Assumptions Adding an IP Address to the API Whitelist Resources Before you use the Admin Console APIs. For information on adding your IP address to the Admin Console whitelist. and HTTP concepts. Before you begin using the Admin Console APIs. and HTTP. SOAP. you should be familiar with XML. To use the APIs.Chapter 1 Overview The Mozy Admin Console APIs allow a third-party company to access the functions of the Admin Console using a third-party tool. you should have a thorough understanding of XML. The Admin Console APIs are SOAP API based-APIs.org/TR/wsdl 9 . you must contact your support representative to get an API key and you must include the IP address of the server accessing the APIs in the Admin Console whitelist. see Adding an IP Address to the API Whitelist on page 10.w3.w3.

mozypro. 3. An element withsoapenc:arrayType attribute has an xsi:type attribute with value soapenc:Array. This attribute is elided in the definitions but included in the examples.1.mozypro.com/api/0. 1. The default namespace is https://www.com/api/0.1.mozypro. These elements are elided in the examples and definitions.wsdl • Restore: https://www.WSDL Files Download There are eight WSDL files for the Admin Console APIs. All requests and responses are wrapped in a standard SOAP envelope and body elements. it is included in the examples. 10 Mozy Admin Console API . Click Log In. the APIs accept the values -1 and 1969-12-31T23:59:59Z for denoting null longs and dateTimes.40/machine/service. respectively.com/api/0.40/user/service. the size portion of the value of the soapenc:arrayType attribute is omitted. You can download them at the following locations: • Partner: https://www. Type your email address and password in the appropriate fields.40/partner/service.wsdl • User: https://www.1. Adding an IP Address to the API Whitelist Before you can use the Admin Console APIs.mozypro.mozypro.40. All requests and responses have an <api_key> element as the first child element.mozypro.wsdl • Admin: https://www.40/resource/service.40/email/service.1. In your browser's address bar. Considerations Certain client libraries make it difficult to specify null values for data types like longs and dateTimes.1.wsdl Assumptions These assumptions apply across all API calls.wsdl • Resource: https://www. type https://mozy. The signature of this element is the following: <api_key xsi:type="xsd:string"/> This element is elided in the examples and definitions.wsdl • User Group: https://www.com/api/0.1.com/api/0.40/admin/service.wsdl • Machine: https://www.mozypro.1. you must add the IP address of the server that is accessing the APIs.com/api/0. As a workaround.xmlsoap. This attribute is elided in the examples and definitions.40/restore/service.com/api/0.1. The root element (excepting the SOAP envelope and body elements) of all requests and responses have the env:encodingStyle attribute set to http://schemas. In the definitions.mozypro. 2.com/api/0.1.wsdl • Email: https://www.mozypro.com/login and press Enter.com/api/0.org/soap/encoding/.40/user_group/service.

11 . type the IP address of the server accessing the APIs.Overview 4. In the API Whitelist field. click Change. 6. 5. click the name of your partner. Next to API Whitelist. In the upper-right corner. You can also add multiple IP address or blocks separated by a comma. Note: IP address can be either a single IP address or a block of IP addresses. then click Submit.

.

Syntax <PartnerFindStruct> <parent_partner_id xsi:type="xsd:long"/> <name xsi:type="xsd:string"/> <company_type xsi:type="xsd:string"/> <subdomain xsi:type="xsd:string"/> <phone xsi:type="xsd:string"/> <root_admin_full_name xsi:type="xsd:string"/> <root_admin_username xsi:type="xsd:string"/> <root_role_id xsi:type="xsd:long"/> <status xsi:type="xsd:string"/> <created_before xsi:type="xsd:dateTime"/> <created_after xsi:type="xsd:dateTime"/> <updated_before xsi:type="xsd:dateTime"/> <updated_after xsi:type="xsd:dateTime"/> <external_id xsi:type="xsd:string"/> <details soapenc:arrayType="PartnerDetailStruct[]"/> <query xsi:type="xsd:string"/> <limit xsi:type="xsd:long"/> <offset xsi:type="xsd:long"/> <no_sub_partners xsi:type="xsd:boolean"/> </PartnerFindStruct> 13 . This data structure can be used instead of using the ID parameter to find or target one or more partners for Get/Update/Delete method calls.Chapter 2 Partner API Major topics include: Topics: • • • • • • • • • Partner PartnerFindStruct Partner PartnerDetailStruct Partner AdminStruct Partner PartnerStruct Partner PartnerResultStruct Partner Get Partner Create Partner Update Partner Delete Partner PartnerFindStruct Represents a custom partner find query.

Supported keys include "industry". created_before Only return partners that were created before this dateTime.. subdomain Partner's subdomain. 14 Mozy Admin Console API . no_sub_partners Return results only from the top-most partner. updated_after Only return partners that have been updated after this dateTime. limit Limits the result set (e. updated_before Only return partners that have been updated before this dateTime.g. and root_admin_username). root_admin_full_name Root admin's full name. root_admin_username Root admin's username. root_role_id The partner's root role. "promo_code" and "user_domain". details Additional details to search off of. name Partner's name.Elements parent_partner_id Parent partner's ID. created_after Only return partners that were created after this dateTime. offset Starting offset used in conjunction with limit. query Case-insensitive search of primary text fields (e.g. root_admin_full_name. name. status The partner's account status ("active" or "incomplete"). company_type The partner's company type ("business". phone Partner's phone number. paging). "reseller" or "corp").. external_id The partner's external id.

key For a list of keys.Partner API Example <PartnerFindStruct> <parent_partner_id xsi:nil="true"></parent_partner_id> <name xsi:nil="true"></name> <company_type xsi:nil="true"></company_type> <subdomain xsi:nil="true"></subdomain> <phone xsi:nil="true"></phone> <root_admin_full_name xsi:nil="true"></root_admin_full_name> <root_admin_username xsi:nil="true"></root_admin_username> <root_role_id xsi:nil="true"></root_role_id> <status xsi:nil="true" ></status> <created_before xsi:nil="true"></created_before> <created_after xsi:nil="true"></created_after> <updated_before xsi:nil="true"></updated_before> <updated_after xsi:nil="true"></updated_after> <external_id xsi:nil="true"></external_id> <details xsi:nil="true"></details> <query xsi:type="xsd:string">example</query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:nil="true"></no_sub_partners> </PartnerFindStruct> Partner PartnerDetailStruct Represents additional information about a partner record. 15 . Example <PartnerDetailStruct> <key xsi:type="xsd:string">user_groups_count</key> <value xsi:type="xsd:string">1</value> </PartnerDetailStruct> Partner AdminStruct Represents the fields and details of an admin record. Syntax <PartnerDetailStruct> <key xsi:type="xsd:string"/> <value xsi:type="xsd:string"/> </PartnerDetailStruct> Elements value Data value corresponding to the key. see the details element at Partner Get on page 19.

id Partner admin's ID. full_name Partner admin's full name. partner_id Partner's ID. Example <AdminStruct> <id xsi:type="xsd:long">5000</id> <partner_id xsi:type="xsd:long">1000</partner_id> <parent_admin_id xsi:type="xsd:long">2000</parent_admin_id> <full_name xsi:type="xsd:string">Jane Doe</full_name> <username xsi:type="xsd:string">jane@example.Syntax <AdminStruct> <id xsi:type="xsd:long"> <partner_id xsi:type="xsd:long"> <parent_admin_id xsi:type="xsd:long"> <full_name xsi:type="xsd:string"> <username xsi:type="xsd:string"> <roles soapenc:arrayType="xsd:long[]"/> <user_groups soapenc:arrayType="xsd:long[]"/> <external_id xsi:type="xsd:string"> <details soapenc:arrayType="AdminDetailStruct[]"/> </AdminStruct> Elements username Partner admin's username. parent_admin_id Parent admin's ID. external_id The admin's external id (this field can be used to track an id or value from an external system). user_groups Partner's user groups. roles Partner admin's roles.com</username> <roles soapenc:arrayType="xsd:long[1]" xsi:type="soapenc:Array"> <item>10</item> </roles> <user_groups soapenc:arrayType="xsd:long[2]" xsi:type="soapenc:Array"> <item>1000</item> <item>2000</item> </user_groups> <external_id xsi:type="xsd:string">c23563</external_id> <details soapenc:arrayType="AdminDetailStruct[1]" xsi:type="soapenc:Array"> 16 Mozy Admin Console API . details Returns additional requested details for each admin.

phone Partner's phone number. id Partner's ID.com/login/admin?token=01234567890abcdef01234567890abcd</value> </item> </details> </AdminStruct> Partner PartnerStruct Represents the fields and details of a partner record.mozypro. default_user_group_id Default user group's ID. root_role_id Partner's root role. root_admin Root admin. name Partner's name. 17 . Syntax <PartnerStruct> <id xsi:type="xsd:long"/> <parent_partner_id xsi:type="xsd:long"/> <name xsi:type="xsd:string"/> <subdomain xsi:type="string"/> <phone xsi:type="string"/> <default_user_group_id xsi:type="xsd:long"/> <root_admin xsi:type="AdminStruct"/> <root_role_id xsi:type="xsd:long/> <status xsi:type="xsd:string"/> <created_at xsi:type="xsd:dateTime"/> <updated_at xsi:type="xsd:dateTime"/> <external_id xsi:type="xsd:string"/> <details soapenc:arrayType="PartnerDetailStruct[]"/> </PartnerStruct> Elements parent_partner_id Parent partner's ID. details Partner description.Partner API <item> <key xsi:type="xsd:string">login_href</key> <value xsi:type="xsd:string">https://www.

</root_admin> <root_role_id xsi:type="xsd:long">123</root_role_id> <status xsi:type="xsd:string">active</status> <created_at xsi:type="xsd:dateTime">2008-10-20T20:00:05Z</created_at> <updated_at xsi:type="xsd:dateTime">2008-10-21T22:22:22Z</updated_at> <external_id xsi:type="xsd:string">c2345</external_id> <details soapenc:arrayType="PartnerDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">user_groups_count</key> <value xsi:type="xsd:string">1</value> </item> </details> </PartnerStruct> Partner PartnerResultStruct Total number of matched partners.. created_at DateTime partner was created. Inc. Example <PartnerStruct> <id xsi:type="xsd:long">2000</id> <parent_partner_id xsi:type="xsd:long">1000</parent_partner_id> <name xsi:type="xsd:string">Example. subdomain Partner's subdomain. external_id Partner's external id (this field can be used to track an id or value from an external system). updated_at DateTime of partner's last update. the size may exceed the actual number of PartnerStruct items in the PartnerResultStruct results..</name> <subdomain xsi:nil="true"></subdomain> <phone xsi:nil="true"></phone> <default_user_group_id xsi:type="xsd:long">2000</default_user_group_id> <root_admin xsi:type="AdminStruct"> .status Partner's account status ("active" or "incomplete"). If limit/offset are specified in the Partner PartnerFindStruct on page 13. Syntax <PartnerResultStruct> <size xsi:type="xsd:long"/> <results soapenc:arrayType="PartnerStruct[]"/> </PartnerResultStruct> Elements results 18 Mozy Admin Console API .

Individual partners can be queried with the id parameter or a custom finder can be used to target multiple partners. size The number of records in results from Partner PartnerStruct on page 17 . all partners will be returned. Inc. Request <Get> <id xsi:type="xsd:long"/> <search xsi:type="PartnerFindStruct"/> <details soapenc:arrayType="xsd:string[]"/> </Get> Response <GetResponse> <result xsi:type="PartnerResultStruct"/> </GetResponse> 19 ..</name> <subdomain xsi:nil="true"></subdomain> <phone xsi:nil="true"></phone> <default_user_group_id xsi:type="xsd:long">2000</default_user_group_id> <root_admin xsi:type="AdminStruct"> . </root_admin> <root_role_id xsi:type="xsd:long">123</root_role_id> <status xsi:type="xsd:string">active</status> <created_at xsi:type="xsd:dateTime">2008-10-20T20:00:05Z</created_at> <updated_at xsi:type="xsd:dateTime">2008-10-21T22:22:22Z</updated_at> <external_id xsi:type="xsd:string">c2345</external_id> <details soapenc:arrayType="PartnerDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">user_groups_count</key> <value xsi:type="xsd:string">1</value> </item> </details> </item> </results> </PartnerResultStruct> Partner Get Returns one or more partners. If both id and search are omitted. Example <PartnerResultStruct> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="PartnerStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">2000</id> <parent_partner_id xsi:type="xsd:long">1000</parent_partner_id> <name xsi:type="xsd:string">Example..Partner API List of records from Partner PartnerStruct on page 17.

The partner's account status ("active" or "suspended"). </root_admin> <root_role_id xsi:type="xsd:long">123</root_role_id> <status xsi:type="xsd:string">active</status> <created_at xsi:type="xsd:dateTime">2008-10-20T20:00:05Z</created_at> <updated_at xsi:type="xsd:dateTime">2008-10-21T22:22:22Z</updated_at> 20 Mozy Admin Console API . Example <Get> <id xsi:type="xsd:long">2000</id> <search xsi:nil="true"></search> <details soapenc:arrayType="xsd:string[1]" xsi:type="soapenc:Array"> <item>user_groups_count</item> </details> </Get> <GetResponse> <return xsi:type="PartnerResultStruct"> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="PartnerStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">2000</id> <parent_partner_id xsi:type="xsd:long">1000</parent_partner_id> <name xsi:type="xsd:string">Example.. details The following information is available to query about the partner: Details user_groups_count industry promo_code status Description Number of user groups.</name> <subdomain xsi:nil="true"></subdomain> <phone xsi:nil="true"></phone> <default_user_group_id xsi:type="xsd:long">2000</default_user_group_id> <root_admin xsi:type="AdminStruct"> . return Results of Partner PartnerResultStruct on page 18. search What you are searching for. The partner's specified industry at the time of signup The partner's promotion code. id Partner's ID.Elements api_key Partner's key that is required to access the API interface. Inc.. See Partner PartnerFindStruct on page 13 for additional information.

In the information box at the bottom of your browser. In order to get this. this is the ID of the root_role. a partner Role must be created that is used to create partners. Note: Before you can create a partner.Partner API <external_id xsi:type="xsd:string">c2345</external_id> <details soapenc:arrayType="PartnerDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">user_groups_count</key> <value xsi:type="xsd:string">1</value> </item> </details> </item> </results> </return> </GetResponse> Partner Create Creates a partner. you must hover over the partner Role in the Admin Console. parent_partner_id Partner's parent partner's ID. This partner Role ID is what is used for the root_role when you create a new partner. Request <Create> <parent_partner_id xsi:type="xsd:long"/> <name xsi:type="xsd:string"/> <company_type xsi:type="xsd:string"/> <subdomain xsi:type="xsd:string"/> <phone xsi:type="xsd:string"/> <root_role xsi:type="xsd:long"/> <root_admin_username xsi:type="xsd:string"/> <root_admin_password xsi:type="xsd:string"/> <root_admin_full_name xsi:type="xsd:string"/> <external_id xsi:type="xsd:string"/> <root_admin_external_id xsi:type="xsd:string"/> </Create> <external_id xsi:type="xsd:string"/> <root_admin_external_id xsi:type="xsd:string"/> Response <CreateResponse> <return xsi:type="xsd:long"/> </CreateResponse> Elements api_key Partner's key that is required to access the API interface. an ID displays in the URL. name 21 .

phone Partner's phone number. This is a required element. This is a required element. root_role Must be a valid role ID.Partner's name. root_admin_password Partner root admin's password.com</root_admin_username> <root_admin_password xsi:type="xsd:string">password</root_admin_password> <root_admin_full_name xsi:type="xsd:string">John Doe</root_admin_full_name> <external_id xsi:type="xsd:string">p123</external_id> <root_admin_external_id xsi:type="xsd:string">a234</root_admin_external_id> </Create> <CreateResponse> <return xsi:type="xsd:long">2000</return> </CreateResponse> 22 Mozy Admin Console API . This is a required element. company_type The partner's company type ("business". subdomain Partner's URL subdomain. root_admin_external_id Root admin's external id (this field can be used to track an id or value from an external system). external_id The partner's external id (this field can be used to track an id or value from an external system). "reseller" or "corp"). root_admin_username Partner root admin's username. This is a required element. Example <Create> <parent_partner_id xsi:type="xsd:long">1000</parent_partner_id> <name xsi:type="xsd:string">Example. This is a required element. return New partner's ID.</name> <company_type xsi:type="xsd:string">business</company_type> <subdomain xsi:nil="true"></subdomain> <phone xsi:nil="true"></phone> <root_role xsi:type="xsd:long">10</root_role> <root_admin_username xsi:type="xsd:string">john@example. root_admin_full_name Partner root admin's full name. Inc.

all partners will be updated. name Partner's name. id ID of the partner you want to update. company_type • Corp • Reseller • Business subdomain Partner's subdomain.Partner API Partner Update Updates one or more partners. search What you are searching for. Alphanumeric. If both id and search are omitted. Must be unique. At least one of the following elements must be passed: • name • company_type • subdomain • phone • root_role • external_id • details Request <Update> <id xsi:type="xsd:long"/> <search xsi:type="PartnerFindStruct"/> <name xsi:type="xsd:string"/> <company_type xsi:type="xsd:string"/> <subdomain xsi:type="xsd:string"/> <phone xsi:type="xsd:string"/> <root_role xsi:type="xsd:long"/> <external_id xsi:type="xsd:string"/> <details soapenc:arrayType="PartnerDetailStruct[]"/> </Update> Response <UpdateResponse> <return xsi:type="xsd:long"/> </UpdateResponse> Elements api_key Partner's key that is required to access the API interface. 23 . Individual partners can be updated with the id parameter. or a custom finder can be used to target multiple partners. Must be a valid partner ID. SeePartner PartnerFindStruct on page 13 for additional information.

Example <Update> <id xsi:type="xsd:long">2000</id> <search xsi:nil="true"/> <name xsi:type="xsd:string">Subdomain II</name> <company_type xsi:nil="true"/> <subdomain xsi:type="xsd:string">subdomain</subdomain> <phone xsi:nil="true"/> <root_role xsi:nil="true"/> <external_id xsi:nil="true"/> <details xsi:nil="true"/> </Update> <UpdateResponse> <return xsi:type="xsd:long">1</return> </UpdateResponse> Partner Delete Deletes one or more partners. If both id and search are omitted. external_id The partner's external id (this field can be used to track an id or value from an external system).phone Partner's phone number. Supported keys include "status". details Additional user details you wish to modify. or a custom finder can be used to target multiple partners. root_role Must be a valid role ID. Request <Delete> <id xsi:type="xsd:long"/> <search xsi:type="PartnerFindStruct"/> </Delete> Response <DeleteResponse> <return xsi:type="xsd:long"/> </DeleteResponse> Elements api_key Partner's key that is required to access the API interface. all partners will be deleted. id 24 Mozy Admin Console API . return Number of updated partners. Individual partners can be deleted with the id parameter.

Partner API Partner's ID search What you are searching for. Example <Delete> <id xsi:type="xsd:long">2000</id> <search xsi:nil="true"></search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> Deleting all subpartners with 'subpartner' in their name: <Delete> <id xsi:nil="true"></id> <search xsi:type="PartnerFindStruct"> <parent_partner_id xsi:nil="true"></parent_partner_id> <name xsi:nil="true"></name> <company_type xsi:nil="true"></company_type> <subdomain xsi:nil="true"></subdomain> <phone xsi:nil="true"></phone> <root_admin_full_name xsi:nil="true"></root_admin_full_name> <root_admin_username xsi:nil="true"></root_admin_username> <query xsi:type="xsd:string">example</query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:nil="true"></no_sub_partners> </search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> 25 . return Number of deleted partners. See Partner PartnerFindStruct on page 13 for additional information.

.

com/login/admin?token=01234567890abcdef01234567890abcd</value> </AdminDetailStruct> 27 .Chapter 3 Admin API Major topics include: Topics: • • • • • • • • Admin AdminDetailStruct Admin AdminFindStruct Admin AdminResultStruct Admin AdminStruct Admin Get Admin Create Admin Update Admin Delete Admin AdminDetailStruct Represents the values of an admin record. see the details element for Admin Get on page 31.mozypro. Syntax <AdminDetailStruct> <key xsi:type="xsd:string"/> <value xsi:type="xsd:string"/> </AdminDetailStruct> Elements value Data value corresponding to the key. key For a list of keys. Example <AdminDetailStruct> <key xsi:type="xsd:string">login_href</key> <value xsi:type="xsd:string">https://www.

limit Limits the result set (e. offset Starting offset used in conjunction with limit.g.Admin AdminFindStruct Represents a custom admin find query. Syntax <AdminFindStruct> <partner_id xsi:type="xsd:long"/> <parent_admin_id xsi:type="xsd:long"/> <full_name xsi:type="xsd:string"/> <username xsi:type="xsd:string"/> <password xsi:type="xsd:string"/> <external_id xsi:type="xsd:string"/> <query type="xsd:string"/> <limit type="xsd:long"/> <offset type="xsd:long"/> <no_sub_partners type="xsd:boolean"/> </AdminFindStruct> <password xsi:type="xsd:string"/> <external_id xsi:type="xsd:string"/> Elements username Admin's username. partner ID Partner's ID. password Admin's password. external_id Admin's external id..g. name and username).. paging). full_name Admin's full name. query Case-insensitive search of primary text fields (e. parent_admin_id Parent admin's ID. 28 Mozy Admin Console API . no_sub_partners Returns results from the top-most partner. This data structure can be used instead of using the id parameter to find or target one or more admins for Get/Update/Delete method calls.

size Total number of matched admins.Admin API Example <AdminFindStruct> <partner_id xsi:nil="true"></partner_id> <parent_admin_id xsi:type="xsd:long">2000</parent_admin_id> <full_name xsi:nil="true"></full_name> <username xsi:nil="true"></username> <password xsi:nil="true"></password> <external_id xsi:nil="true"></external_id> <query xsi:type="xsd:string">jane</query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:type="xsd:boolean">true</no_sub_partners> </AdminFindStruct> Admin AdminResultStruct Represents the results of the AdminStruct. If limit/offset are specified in the Admin AdminFindStruct on page 28. Syntax <AdminResultStruct> <size xsi:type="xsd:long"/> <results soapenc:arrayType="AdminStruct[]"/> </AdminResultStruct> Elements results The list admins from Admin AdminStruct on page 30. the size may exceed the actual number of AdminStruct items in the AdminResultStruct results. Example <AdminResultStruct> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="AdminStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">5000</id> <partner_id xsi:type="xsd:long">1000</partner_id> <parent_admin_id xsi:type="xsd:long">2000</parent_admin_id> <full_name xsi:type="xsd:string">Jane Doe</full_name> <username xsi:type="xsd:string">jane@example.com</username> <roles soapenc:arrayType="xsd:long[1]" xsi:type="soapenc:Array"> <item>10</item> </roles> <user_groups soapenc:arrayType="xsd:long[2]" xsi:type="soapenc:Array"> <item>1000</item> <item>2000</item> </user_groups> <external_id xsi:type="xsd:string">c23563</external_id> <details soapenc:arrayType="AdminDetailStruct[1]" 29 .

details 30 Mozy Admin Console API . user_groups Admin's user groups.com/login/admin?token=01234567890abcdef01234567890abcd</value> </item> </details> </item> </results> </AdminResultStruct> Admin AdminStruct Represents the fields and details of an admin record. parent_admin_id Parent admin's ID. external_id Admin's external id (this field can be used to track an id or value from an external system).xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">login_href</key> <value xsi:type="xsd:string">https://www. full_name Admin's full name. roles Admin's roles. id Admin's ID.mozypro. partner_id Partner's ID. Syntax <AdminStruct> <id xsi:type="xsd:long"> <partner_id xsi:type="xsd:long"> <parent_admin_id xsi:type="xsd:long"> <full_name xsi:type="xsd:string"> <username xsi:type="xsd:string"> <roles soapenc:arrayType="xsd:long[]"/> <user_groups soapenc:arrayType="xsd:long[]"/> <external_id xsi:type="xsd:string"> <details soapenc:arrayType="AdminDetailStruct[]"/> </AdminStruct> Elements username Admin's username.

Individual admins can be queried with the id parameter.mozypro. id Admin's ID. Example <AdminStruct> <id xsi:type="xsd:long">5000</id> <partner_id xsi:type="xsd:long">1000</partner_id> <parent_admin_id xsi:type="xsd:long">2000</parent_admin_id> <full_name xsi:type="xsd:string">Jane Doe</full_name> <username xsi:type="xsd:string">jane@example. search What you are searching for. Request <Get> <id xsi:type="xsd:long"/> <search xsi:type="AdminFindStruct"/> <details soapenc:arrayType="xsd:string[]"/> </Get> Response <GetResponse> <result xsi:type="AdminResultStruct"/> </GetResponse> Elements api_key Partner's key that is required to access the API interface. all admins are returned.Admin API Returns additional requested details for each admin. or a custom finder can be used to target multiple admins.com</username> <roles soapenc:arrayType="xsd:long[1]" xsi:type="soapenc:Array"> <item>10</item> </roles> <user_groups soapenc:arrayType="xsd:long[2]" xsi:type="soapenc:Array"> <item>1000</item> <item>2000</item> </user_groups> <external_id xsi:type="xsd:string">c23563</external_id> <details soapenc:arrayType="AdminDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">login_href</key> <value xsi:type="xsd:string">https://www. If both id and search are omitted. See Admin AdminFindStruct on page 28 for additional information.com/login/admin?token=01234567890abcdef01234567890abcd</value> </item> </details> </AdminStruct> Admin Get Returns one or more admins. 31 .

return Results of Admin AdminResultStruct on page 29.com</username> <roles soapenc:arrayType="xsd:long[1]" xsi:type="soapenc:Array"> <item>10</item> </roles> <user_groups soapenc:arrayType="xsd:long[2]" xsi:type="soapenc:Array"> <item>1000</item> <item>2000</item> </user_groups> <external_id xsi:type="xsd:string">c23563</external_id> <details soapenc:arrayType="AdminDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">login_href</key> <value xsi:type="xsd:string">https://www. Example <Get> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> <details soapenc:arrayType="xsd:string[1]" xsi:type="soapenc:Array"> <item>login_href</item> </details> </Get> <GetResponse> <return xsi:type="AdminResultStruct"> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="AdminStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">5000</id> <partner_id xsi:type="xsd:long">1000</partner_id> <parent_admin_id xsi:type="xsd:long">2000</parent_admin_id> <full_name xsi:type="xsd:string">Jane Doe</full_name> <username xsi:type="xsd:string">jane@example.details The following information is available to query about the admin: Detail login_href Description Special URL that will automatically log in the admin.mozypro. The URL contains a login token that is valid for 10 seconds.com/login/admin?token=01234567890abcdef01234567890abcd</value> </item> </details> </item> </results> </return> </GetResponse> 32 Mozy Admin Console API .

username Admin's username.Admin API Admin Create Creates an admin. external_id Admin's external id (this field can be used to track an id or value from an external system).com</username> <password xsi:nil="true"></password> <full_name xsi:type="xsd:string">Jane Doe</full_name> 33 . full_name Admin's full name. roles Admin's roles. This element is required. Must be a list of valid user group IDs. This element is required. return Returns the ID of the newly created admin. user_groups Admin's user groups. Example <Create> <parent_admin_id xsi:type="xsd:long">2000</parent_admin_id> <username xsi:type="xsd:string">jane@example. Must be a list of valid role IDs. password Admin's password. This element is required. Request <Create> <parent_admin_id xsi:type="xsd:long"/> <username xsi:type="xsd:string"/> <password xsi:type="xsd:string"/> <full_name xsi:type="xsd:string"/> <roles soapenc:arrayType="xsd:long[]"/> <user_groups soapenc:arrayType="xsd:long[]"/> <external_id xsi:type="xsd:string"/> </Create> Response <CreateResponse> <return xsi:type="xsd:long"/> </CreateResponse> Elements api_key Partner's key that is required to access the API interface. parent_admin_id Admin's parent admin's ID.

search What you are searching for. If both id and search are omitted. See Admin AdminFindStruct on page 28 for additional information. At least one of the following elements must be passed: • parent_admin_id • username • password • full_name • roles • user_groups • external_id Request <Update> <id xsi:type="xsd:long"/> <search xsi:type="AdminFindStruct"/> <parent_admin_id xsi:type="xsd:long"/> <username xsi:type="xsd:string"/> <password xsi:type="xsd:string"/> <full_name xsi:type="xsd:string"/> <roles soapenc:arrayType="xsd:long[]"/> <user_groups soapenc:arrayType="xsd:long[]"/> <external_id xsi:type="xsd:string"/> </Update> Response <UpdateResponse> <return xsi:type="xsd:long"/> </UpdateResponse> Elements api_key Partner's key that is required to access the API interface. id Admin's ID. all admins are updated. or a custom finder can be used to target multiple admins. Individual admins can be updated with the id parameter.<roles soapenc:arrayType="xsd:long[1]" xsi:type="soapenc:Array"> <item>10</item> </roles> <user_groups soapenc:arrayType="xsd:long[1]" xsi:type="soapenc:Array"> <item>2000</item> </user_groups> <external_id xsi:type="xsd:string">c2345</external_id> </Create> <CreateResponse> <return xsi:type="xsd:long">5000</return> </CreateResponse> Admin Update Updates one or more admins. 34 Mozy Admin Console API .

Admin API parent_admin_id Admin's parent admin's ID. or a custom finder can be used to target multiple admins. password Admin's password.com</username> <password xsi:nil="true"></password> <full_name xsi:nil="true"></full_name> <roles xsi:nil="true"></roles> <user_groups soapenc:arrayType="xsd:long[2]" xsi:type="soapenc:Array"> <item>2000</item> <item>5000</item> </user_groups> <external_id xsi:type="xsd:string">c2345</external_id> </Update> <UpdateResponse> <return xsi:type="xsd:long">1</return> </UpdateResponse> Admin Delete Deletes one or more admins. Must be a list of valid user group IDs. external_id Admin's external id (this field can be used to track an id or value from an external system). If both id and search are omitted. Example <Update> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"/> <parent_admin_id xsi:nil="true"></parent_admin_id> <username xsi:type="xsd:string">jane@example. return Number of admins updated. Request <Delete> <id xsi:type="xsd:long"/> <search xsi:type="AdminFindStruct"/> </Delete> 35 . username Admin's username. all admins are deleted. Must be a list of valid role IDs. roles Admin's roles. full_name Admin's full name. Individual admins can be deleted with the id parameter. user_groups Admin's user groups.

return Number of deleted admins. Example <Delete> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> Deleting all subadmins with 'doe' in their display name: <Delete> <id xsi:nil="true"></id> <search xsi:type="AdminFindStruct"> <partner_id xsi:nil="true"></partner_id> <parent_admin_id xsi:type="xsd:long">2000</parent_admin_id> <full_name xsi:nil="true"></full_name> <username xsi:nil="true"></username> <query xsi:type="xsd:string">jane</query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:type="xsd:boolean">true</no_sub_partners> </search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> 36 Mozy Admin Console API . id Admin's ID. See User UserFindStruct on page 48 for additional information.Response <DeleteResponse> <return xsi:type="xsd:long"/> </DeleteResponse> Elements api_key Partner's key that is required to access the API interface. search What you are searching for.

Chapter 4
User Group API
Major topics include:

Topics: • • • • • • • • • User Group UserGroupQuotaStruct User Group UserGroupStruct User Group UserGroupDetailStruct User Group UserGroupFindStruct User Group UserGroupResultStruct User Group Get User Group Create User Group Update User Group Delete

User Group UserGroupQuotaStruct
Represents the fields and details of a user group quota. Syntax <UserGroupQuotaStruct> <type xsi:type="xsd:string"/> <quota xsi:type="xsd:long"/> </UserGroupQuotaStruct> Elements type String representation of the license type of the quota. For example, Desktop or Server. quota Amount of quota (in GB) of the given type. Example <UserGroupQuotaStruct> <type xsi:type="xsd:string">Desktop</type> <quota xsi:type="xsd:long">2097152</quota> </UserGroupQuotaStruct>

37

User Group UserGroupStruct
Represents the fields and details of a user group record. Syntax <UserGroupStruct> <id xsi:type="xsd:long"> <partner_id xsi:type="xsd:long"> <name xsi:type="xsd:string"> <default_quotas soapenc:arrayType="UserGroupQuotaStruct[]"/> <details soapenc:arrayType="UserGroupDetailStruct[]"/> <external_id xsi:type="xsd:string"/> </UserGroupStruct> Elements default_quotas Amount of storage quota assigned to a user by default. name User's name. details Any requested details about the user group. For additional information, see User Group Get on page 41. partner_id Partner's ID. id User's ID. external_id User group's external id (this field can be used to track an id or value from an external system). Example <UserGroupStruct> <id xsi:type="xsd:long">2000</id> <partner_id xsi:type="xsd:long">1000</partner_id> <name xsi:type="xsd:string">(default user group)</name> <default_quotas soapenc:arrayType="UserGroupQuotaStruct[2]" xsi:type="soapenc:Array"> <item> <type xsi:type="xsd:string">Desktop</type> <quota xsi:type="xsd:long">2097152</quota> </item> <item> <type xsi:type="xsd:string">Server</type> <quota xsi:type="xsd:long">20971520</quota> </item> </default_quotas> <details soapenc:arrayType="UserGroupDetailStruct[2]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">users_count</key>

38

Mozy Admin Console API

User Group API

<value xsi:type="xsd:string">5</value> </item> </details> <external_id xsi:type="xsd:string">g1234</external_id> </UserGroupStruct>

User Group UserGroupDetailStruct
A data structure that represents additional information about a user group record. Syntax <UserGroupDetailStruct> <key xsi:type="xsd:string"/> <value xsi:type="xsd:string"/> </UserGroupDetailStruct> Elements value Data value corresponding to the key. key For a list of keys, see the details element for User Group Get on page 41. Example <UserGroupDetailStruct> <key xsi:type="xsd:string">users_count</key> <value xsi:type="xsd:string">5</value> </UserGroupDetailStruct>

User Group UserGroupFindStruct
Represents a custom user group find query. This data structure can be used instead of using the id parameter to find or target one or more user groups for Get/Update/Delete method calls. Syntax <UserGroupFindStruct> <partner_id xsi:type="xsd:long"/> <name xsi:type="xsd:string"/> <external_id xsi:type="xsd:string"/> <query xsi:type="xsd:string"/> <limit xsi:type="xsd:long"/> <offset xsi:type="xsd:long"/> <no_sub_partners xsi:type="xsd:boolean"/> </UserGroupFindStruct> Elements no_sub_partners Returns results from the topmost partner.

39

name User group's name. offset Starting offset used in conjunction with limit. limit Limits the result set (e.g., paging). partner_id Partner's ID. external_id User group's external id. query Case-insensitive search of primary text fields (i.e., name). Example <UserGroupFindStruct> <partner_id xsi:nil="true"></partner_id> <name xsi:nil="true"></name> <external_id xsi:nil="true"></external_id> <query xsi:type="xsd:string">new</query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:type="xsd:boolean">true</no_sub_partners> </UserGroupFindStruct>

User Group UserGroupResultStruct
Represents the results of a UserGroupStruct. Syntax <UserGroupResultStruct> <size xsi:type="xsd:long"/> <results soapenc:arrayType="UserGroupStruct[]"/> </UserGroupResultStruct> Elements results List of records from User Group UserGroupStruct on page 38. size Total number of matched user groups. If limit/offset are specified in the User Group UserGroupFindStruct on page 39, the size may exceed the actual number of UserGropStruct items in the UserGroupResultStruct results. Example <UserGroupResultStruct> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="UserGroupStruct[1]" xsi:type="soapenc:Array">

40

Mozy Admin Console API

id User group's ID. For additional information. search What you are searching for. all user groups will be returned. If both id and search are omitted. Individual user groups can be queried with the id parameter or a custom finder can be used to target multiple user groups. 41 . see User Group UserGroupFindStruct on page 39. Request <Get> <id xsi:type="xsd:long"/> <search xsi:type="UserGroupFindStruct"/> <details soapenc:arrayType="xsd:string[]"/> </Get> Response <GetResponse> <result xsi:type="UserGroupResultStruct"/> </GetResponse> Elements api_key Partner's key that is required to access the API interface.User Group API <item> <id xsi:type="xsd:long">2000</id> <partner_id xsi:type="xsd:long">1000</partner_id> <name xsi:type="xsd:string">(default user group)</name> <default_quotas soapenc:arrayType="UserGroupQuotaStruct[2]" xsi:type="soapenc:Array"> <item> <type xsi:type="xsd:string">Desktop</type> <quota xsi:type="xsd:long">2097152</quota> </item> <item> <type xsi:type="xsd:string">Server</type> <quota xsi:type="xsd:long">20971520</quota> </item> </default_quotas> <details soapenc:arrayType="UserGroupDetailStruct[2]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">users_count</key> <value xsi:type="xsd:string">5</value> </item> </details> <external_id xsi:type="xsd:string">g1234</external_id> </item> </results> </UserGroupResultStruct> User Group Get Returns one or more user groups.

return Returns results of User Group UserGroupResultStruct on page 40. external_id The user group's external id (this field can be used to track an id or value from an external system). Example <Get> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> <details soapenc:arrayType="xsd:string[1]" xsi:type="soapenc:Array"> <item>users_count</item> </details> </Get> <GetResponse> <return xsi:type="UserGroupResultStruct"> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="UserGroupStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">2000</id> <partner_id xsi:type="xsd:long">1000</partner_id> <name xsi:type="xsd:string">(default user group)</name> <default_quotas soapenc:arrayType="UserGroupQuotaStruct[2]" xsi:type="soapenc:Array"> <item> <type xsi:type="xsd:string">Desktop</type> <quota xsi:type="xsd:long">2097152</quota> </item> <item> <type xsi:type="xsd:string">Server</type> <quota xsi:type="xsd:long">20971520</quota> </item> </default_quotas> <details soapenc:arrayType="UserGroupDetailStruct[2]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">users_count</key> <value xsi:type="xsd:string">5</value> </item> </details> <external_id xsi:type="xsd:string">g1234</external_id> </item> </results> </return> </GetResponse> 42 Mozy Admin Console API .details The following information is available to query about the user group: Detail users_count status Description Number of users belonging to the user group. The user group's account status ("active" or "suspended").

Use User Group UserGroupQuotaStruct on page 37 to specify the quota. default quota Default storage space quota for each license. One per license type. Minimum 1 GB.User Group API User Group Create Creates a user group. default_for_partner Whether this group will be the default for the partner. Example <Create> <partner_id xsi:type="xsd:long">2000</parent_admin_id> <name xsi:type="xsd:string">New User Group</username> <default_quotas soapenc:arrayType="xsd:UserGroupQuotaStruct[2]" xsi:type="soapenc:Array"> <item> <type xsi:type="xsd:string">Desktop</type> <quota xsi:type="xsd:long">2097152</quota> </item> <item> <type xsi:type="xsd:string">Server</type> 43 . name User group's name. and use -1 for unlimited quota. This element is required. partner_id ID of the partner who owns the user group. return New user group's ID. Request <Create> <partner_id xsi:type="xsd:long"/> <name xsi:type="xsd:string"/> <default_quotas soapenc:arrayType="UserGroupQuotaStruct[]"/> <default_for_partner xsi:type="xsd:boolean"/> <external_id xsi:type="xsd:string"/> </Create> Response <CreateResponse> <return xsi:type="xsd:long"/> </CreateResponse> Elements api_key Partner's key that is required to access the API interface. external_id User group's external id (this field can be used to track an id or value from an external system).

name User group's name.<quota xsi:type="xsd:long">5242880</quota> </item> </default_quotas> <default_for_partner xsi:type="xsd:boolean">false</default_for_partner> <external_id xsi:type="xsd:string">g1234</external_id> </Create> <CreateResponse> <return xsi:type="xsd:long">5000</return> </CreateResponse> User Group Update Updates one or more user groups. search What you are searching for. If both id and search are omitted. all user groups will be updated. or a custom finder can be used to target multiple user groups. id User group's ID. default quota 44 Mozy Admin Console API . see User Group UserGroupFindStruct on page 39. At least one of the following elements must be passed: • name • default_quotas • default_for_partner • external_id • details Request <Update> <id xsi:type="xsd:long"/> <search xsi:type="UserGroupFindStruct"/> <name xsi:type="xsd:string"/> <default_quotas soapenc:arrayType="UserGroupQuotaStructs[]"/> <default_for_partner xsi:type="xsd:boolean"/> <external_id xsi:type="xsd:string"/> <details soapenc:arrayType="UserGroupDetailStruct[]"/> </Update> Response <UpdateResponse> <return xsi:type="xsd:long"/> </UpdateResponse> Elements api_key Partner's key that is required to access the API interface. Individual user groups can be updated with the id parameter. For additional information.

all user groups will be deleted. Individual user groups can be deleted with the id parameter. Use User Group UserGroupQuotaStruct on page 37 to specify the quota. Request <Delete> <id xsi:type="xsd:long"/> <search xsi:type="UserGroupFindStruct"/> </Delete> Response <DeleteResponse> <return xsi:type="xsd:long"/> </DeleteResponse> 45 . Supported keys include "status". and use -1 for unlimited quota. Example <Update> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> <name xsi:type="xsd:string">New User Group II</name> <default_quotas soapenc:arrayType="UserGroupQuotaStruct[1]" xsi:type="soapenc:Array"> <item> <type xsi:type="xsd:string">Desktop</type> <quota xsi:type="xsd:long">2097152</quota> </item> </default_quotas> <default_for_partner xsi:nil="true"></default_for_partner> <external_id xsi:type="xsd:string">g1234</external_id> <details xsi:nil="true"/> </Update> <UpdateResponse> <return xsi:type="xsd:long">1</return> </UpdateResponse> User Group Delete Deletes one or more user groups. If both id and search are omitted. Minimum 1 GB. or a custom finder can be used to target multiple user groups. external_id User group's external id (this field can be used to track an id or value from an external system). One per license type..User Group API Default storage space quota for each license. details Additional user group details you wish to modify. default_for_partner Whether this group will be the default for the partner. return Number of user groups updated.

See User Group UserGroupFindStruct on page 39 for additional information.Elements api_key Partner's key that is required to access the API interface. Example <Delete> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> Deleting all user groups with 'new' in their name: <Delete> <id xsi:nil="true"></id> <search xsi:type="UserGroupFindStruct"> <partner_id xsi:nil="true"></partner_id> <name xsi:nil="true"></name> <query xsi:type="xsd:string">new</query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:type="xsd:boolean">true</no_sub_partners> </search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> 46 Mozy Admin Console API . id User group's ID. return Number of deleted user groups. search What you are searching for.

see the details element for User Get on page 51. Syntax <UserDetailStruct> <key xsi:type="xsd:string"/> <value xsi:type="xsd:string"/> </UserDetailStruct> Elements value Data value corresponding to the key. key For a list of keys. Example <UserDetailStruct> <key xsi:type="xsd:string">machines_count</key> <value xsi:type="xsd:string">3</value> </UserDetailStruct> 47 .Chapter 5 User API Major topics include: Topics: • • • • • • • • User UserDetailStruct User UserFindStruct User UserResultStruct User UserStruct User Get User Create User Update User Delete User UserDetailStruct Represents the values of a user record.

no_sub_partners Returns results only for the top-most partner. limit Limits the result set (e.. full_name User's full name. user_group_id User group's ID. paging).e. username User's username. Supported keys include "status" and "language". Syntax <UserFindStruct> <partner_id xsi:type="xsd:long"/> <user_group_id xsi:type="xsd:long"/> <full_name xsi:type="xsd:string"/> <username xsi:type="xsd:string"/> <password xsi:type="xsd:string"/> <details soapenc:arrayType="UserDetailStruct[]"/> <external_id xsi:type="xsd:string"/> <ids soapenc:arrayType="xsd:long[]"/> <query type="xsd:string"/> <limit type="xsd:long"/> <offset type="xsd:long"/> <no_sub_partners type="xsd:boolean"/> </UserFindStruct > Elements partner_id Partner ID.g.. ids List of user ID's to search query Case-insensitive search of primary text fields (i. details Additional details to search off of. username). external_id User's external id.User UserFindStruct Represents the values of a partner find. 48 Mozy Admin Console API . offset Starting offset used in conjunction with limit. password User's password. full_name.

com</username> <details soapenc:arrayType="UserDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">machines_count</key> <value xsi:type="xsd:string">3</value> </item> </details> <external_id xsi:nil="true"></external_id> </item> </results> </UserResultStruct> 49 .User API Example <UserFindStruct> <partner_id xsi:nil="true"></partner_id> <user_group_id xsi:type="xsd:long">2000</user_group_id> <full_name xsi:nil="true"></full_name> <username xsi:nil="true"></username> <password xsi:nil="true"></password> <details xsi:nil="true"></details> <external_id xsi:nil="true"></external_id> <ids xsi:nil="true"></ids> <query xsi:type="xsd:string">jane</query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:type="xsd:boolean">true</no_sub_partners> </UserFindStruct> User UserResultStruct Represents the returned results of a user record. Syntax <UserResultStruct> <size xsi:type="xsd:long"/> <results soapenc:arrayType="UserStruct[]"/> </UserResultStruct> Elements results List of records fromUser UserStruct on page 50. size Number of records fromUser UserStruct on page 50 in the results. Example <UserResultStruct> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="UserStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">5000</id> <user_group_id xsi:type="xsd:long">2000</user_group_id> <full_name xsi:type="xsd:string">Jane Doe</full_name> <username xsi:type="xsd:string">jane@example.

external_id User's external id (this field can be used to track an id or value from an external system). Syntax <UserStruct> <id xsi:type="xsd:long"> <user_group_id xsi:type="xsd:long"> <full_name xsi:type="xsd:string"> <username xsi:type="xsd:string"> <details soapenc:arrayType="UserDetailStruct[]"/> <external_id xsi:type="xsd:string"/> </UserStruct> Elements username User's username.User UserStruct Represents the fields and details of a user record. details Returns additional requested details for each user. Example <UserStruct> <id xsi:type="xsd:long">5000</id> <user_group_id xsi:type="xsd:long">2000</user_group_id> <full_name xsi:type="xsd:string">Jane Doe</full_name> <username xsi:type="xsd:string">jane@example. full_name User's full name. user_group_id User group's ID.com</username> <details soapenc:arrayType="UserDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">machines_count</key> <value xsi:type="xsd:string">3</value> </item> </details> <external_id xsi:nil="true"></external_id> </UserStruct> 50 Mozy Admin Console API . id User's ID.

The user's account status ("active" or "suspended"). all users will be returned. search What you are searching for. The root_admin_id for this user's partner. Default is "en" root_admin_id deleted_at deleted user_domain total_quota status language return 51 . Individual users can be queried with the id parameter. Request <Get> <id xsi:type="xsd:long"/> <search xsi:type="UserFindStruct"/> <details soapenc:arrayType="xsd:string[]"/> </Get> Response <GetResponse> <result xsi:type="UserResultStruct"/> </GetResponse> Elements api_key Partner's key that is required to access the API interface.com). Special URL that will automatically log in the user. If both id and search are omitted. Amount of quota (in KB) for the user.User API User Get Returns one or more users. Date and time of most recent successful backup. The user's preferred language setting. see User UserFindStruct on page 48. Amount of quota (in bytes) used by the user. The URL contains a login token that is valid for 10 seconds. Includes both user and machine-level quotas.g. For additional information. Number of machines associated with the user. mozy. details The following information is available to query about the user: Detail quota_bytes quota_used_bytes machines_count last_backup_at login_href Description Amount of quota (in bytes) for the user. The dateTime this user was deleted Whether or not this user is deleted ("true" or "false") The domain where this user logs in (e. or a custom finder can be used to target multiple users. id User's ID.

com</username> <details soapenc:arrayType="UserDetailStruct[2]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">machines_count</key> <value xsi:type="xsd:string">3</value> </item> <item> <key xsi:type="xsd:string">quota_used_bytes</key> <value xsi:type="xsd:string">123456789012</value> </item> </details> <external_id xsi:nil="true"></external_id> </item> </results> </return> </GetResponse> User Create Creates a user. Example <Get> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> <details soapenc:arrayType="xsd:string[2]" xsi:type="soapenc:Array"> <item>machines_count</item> <item>quota_used_bytes</item> </details> </Get> <GetResponse> <return xsi:type="UserResultStruct"> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="UserStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">5000</id> <user_group_id xsi:type="xsd:long">2000</user_group_id> <full_name xsi:type="xsd:string">Jane Doe</full_name> <username xsi:type="xsd:string">jane@example. Request <Create> <user_group_id xsi:type="xsd:long"/> <username xsi:type="xsd:string"/> <password xsi:type="xsd:string"/> <full_name xsi:type="xsd:string"/> <details soapenc:arrayType="UserDetailStruct[]"/> <external_id xsi:type="xsd:string"/> </Create> Response <CreateResponse> <return xsi:type="xsd:long"/> </CreateResponse> 52 Mozy Admin Console API .Results of the User UserResultStruct on page 49.

This element is required. Example <Create> <user_group_id xsi:type="xsd:long">2000</user_group_id> <username xsi:type="xsd:string">jane@example. username User's user name. password User's password. user_group_id User's user group's ID. external_id The user's external id (this field can be used to track an id or value from an external system).com</username> <password xsi:nil="true"></password> <full_name xsi:type="xsd:string">Jane Doe</full_name> <details xsi:nil="true"></details> <external_id xsi:type="xsd:string">c2345</external_id> </Create> <CreateResponse> <return xsi:type="xsd:long">5000</return> </CreateResponse> User Update Updates one or more users.User API Elements api_key Partner's key that is required to access the API interface. Supported keys include "language". Individual users can be updated with the id parameter. At least one of the following elements must be passed: • user_group_id • username • password • full_name • details • external_id 53 . all users will be updated. return User's ID. details Additional details to specify for this new user. or a custom finder can be used to target multiple users. full_name User's full name. If both id and search are omitted. This element is required.

external_id User's external id (this field can be used to track an id or value from an external system). id User's ID. Example <Update> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"/> <user_group_id xsi:nil="true"></user_group_id> <username xsi:type="xsd:string">jane@example. username User's user name.com</username> <password xsi:nil="true"></password> 54 Mozy Admin Console API . full_name User's full name. details Additional user details you wish to modify. For additional information.Request <Update> <id xsi:type="xsd:long"/> <search xsi:type="UserFindStruct"/> <user_group_id xsi:type="xsd:long"/> <username xsi:type="xsd:string"/> <password xsi:type="xsd:string"/> <full_name xsi:type="xsd:string"/> <details soapenc:arrayType="UserDetailStruct[]"/> <external_id xsi:type="xsd:string"/> </Update> Response <UpdateResponse> <return xsi:type="xsd:long"/> </UpdateResponse> Elements api_key Partner's key that is required to access the API interface. user_group_id User's user group's ID. Supported keys include "language". password User's password. see User UserFindStruct on page 48. return Number of users updated. search What you are searching for.

or a custom finder can be used to target multiple users. id User's ID. For additional information. Request <Delete> <id xsi:type="xsd:long"/> <search xsi:type="UserFindStruct"/> </Delete> Response <DeleteResponse> <return xsi:type="xsd:long"/> </DeleteResponse> Elements api_key Partner's key that is required to access the API interface. see User UserFindStruct on page 48. all users will be deleted.User API <full_name xsi:nil="true"></full_name> <details xsi:nil="true"></details> <external_id xsi:nil="true"></external_id> </Update> <UpdateResponse> <return xsi:type="xsd:long">1</return> </UpdateResponse> User Delete Deletes one or more users. Individual users can be deleted with the id parameter. If both id and search are omitted. search What you are searching for. return Number of users deleted. Example Deleting a specific user: <Delete> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> Deleting all users in user group id 2000 named 'John Doe': <Delete> <id xsi:nil="true"></id> <search xsi:type="UserFindStruct"> <user_group_id xsi:type="xsd:long">2000</user_group_id > 55 .

<full_name xsi:type="xsd:string">John Doe</full_name> <username xsi:nil="true"></username> <query xsi:nil="true"></query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:type="xsd:boolean">true</no_sub_partners> </search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> 56 Mozy Admin Console API .

Example <MachineResultStruct> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="MachineStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">5000</id> 57 . If limit/offset are specified in Machine MachineFindStruct on page 60. Syntax <MachineResultStruct> <size xsi:type="xsd:long"/> <results soapenc:arrayType="MachineStruct[]"/> </MachineResultStruct> Elements results List fromMachine MachineStruct on page 58.Chapter 6 Machine API Major topics include: Topics: • • • • • • • • Machine MachineResultStruct Machine MachineStruct Machine MachineDetailStruct Machine MachineFindStruct Machine Get Machine Create Machine Update Machine Delete Machine MachineResultStruct Represents the returned results of a machine record. size Total number of matched users. the size may exceed the actual number of MachineStruct items in the MachineResultStruct results.

<user_id xsi:type="xsd:long">1000</user_id> <alias xsi:type="xsd:string">COMPUTER</alias> <keystring xsi:type="xsd:long">abcde12345</keystring> <created_at xsi:type="xsd:dateTime">2008-01-01T00:00:00Z</created_at> <quota xsi:type="xsd:long">2097152</quota> <quota_used_bytes xsi:type="xsd:long">536870912</quota_used_bytes> <files xsi:type="xsd:long">10000</files> <status xsi:type="xsd:string">active</status> <details soapenc:arrayType="MachineDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">machine_hash</key> <value xsi:type="xsd:string">a1b2c3d4e5</value> </item> </details> <last_backup_at xsi:type="xsd:dateTime">2008-10-01T01:23:00Z</last_backup_at> <external_id xsi:type="xsd:string">m2345</external_id> </item> </results> </MachineResultStruct> Machine MachineStruct Represents the fields and details of a machine record. status Status of the machine. Syntax <MachineStruct> <id xsi:type="xsd:long"/> <user_id xsi:type="xsd:long"/> <alias xsi:type="xsd:string"/> <keystring xsi:type="xsd:string"/> <created_at xsi:type="xsd:datetime"/> <quota xsi:type="xsd:long"/> <quota_used_bytes xsi:type="xsd:long"/> <files xsi:type="xsd:long"/> <status xsi:type="xsd:string"/> <details soapenc:arrayType="MachineDetailStruct[]"/> <last_backup_at xsi:type="xsd:datetime"/> <external_id xsi:type="xsd:string"/> </MachineStruct> Elements files Admin's username. details keystring 58 Mozy Admin Console API . quota Amount of storage quota assigned to the machine.

created_at alias Machine's alias. quota_used_bytes Amount of quota used. id Machine's ID. user_id User's ID. external_id Machine's external id (this field can be used to track an id or value from an external system). last_backup_at DateTime of the machine's last successful backup.Machine API Machine's license key string. Syntax <MachineDetailStruct> <key xsi:type="xsd:string"/> <value xsi:type="xsd:string"/> </MachineDetailStruct> 59 . Example <MachineStruct> <id xsi:type="xsd:long">5000</id> <user_id xsi:type="xsd:long">1000</user_id> <alias xsi:type="xsd:string">COMPUTER</alias> <keystring xsi:type="xsd:long">abcde12345</keystring> <created_at xsi:type="xsd:dateTime">2008-01-01T00:00:00Z</created_at> <quota xsi:type="xsd:long">2097152</quota> <quota_used_bytes xsi:type="xsd:long">536870912</quota_used_bytes> <files xsi:type="xsd:long">10000</files> <status xsi:type="xsd:string">active</status> <details soapenc:arrayType="MachineDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">machine_hash</key> <value xsi:type="xsd:string">a1b2c3d4e5</value> </item> </details> <last_backup_at xsi:type="xsd:dateTime">2008-10-01T01:23:00Z</last_backup_at> <external_id xsi:type="xsd:string">m2345</external_id> </MachineStruct> Machine MachineDetailStruct Represents the values of a machine record.

Elements value Data value corresponding to the key. paging). status Status of the machine (active/suspend). offset Starting offset used in conjunction with limit.. Example <MachineDetailStruct> <key xsi:type="xsd:string">machine_hash</key> <value xsi:type="xsd:string">a1b2c3d4e5</value> </MachineDetailStruct> Machine MachineFindStruct Represents a custom machine find query. 60 Mozy Admin Console API . no_sub_partners Return results only from the top-most partner . Syntax <MachineFindStruct> <partner_id xsi:type="xsd:long"/> <user_group_id xsi:type="xsd:long"/> <user_id xsi:type="xsd:long"/> <alias xsi:type="xsd:string"/> <keystring xsi:type="xsd:string"/> <status xsi:type="xsd:string"/> <user_ids soapenc:arrayType="xsd:long[]"/> <backed_up_before xsi:type="xsd:dateTime"/> <backed_up_after xsi:type="xsd:dateTime"/> <external_id xsi:type="xsd:string"/> <details soapenc:arrayType="MachineDetailStruct[]"/> <query xsi:type="xsd:string"/> <limit xsi:type="xsd:long"/> <offset xsi:type="xsd:long"/> <no_sub_partners xsi:type="xsd:boolean"/> </MachineFindStruct> Elements user_group_id User group's ID. limit Limits the result set (e.g. key For a list of keys. see the details element for Machine Get on page 61. This data structure can be used instead of the id parameter to find or target one or more machines for Get/Update/Delete method calls.

There are currently no supported keys/values for this element. 61 . so it should be left empty or nil.e. alias Machine's alias. query Case-insensitive search of primary text fields (i. Example <MachineFindStruct> <partner_id xsi:nil="true"></partner_id> <user_group_id xsi:nil="true"></user_group_id> <user_id xsi:nil="true"></user_id> <alias xsi:nil="true"></alias> <keystring xsi:nil="true"></keystring> <status xsi:nil="true"></status> <user_ids xsi:nil="true"></user_ids> <backed_up_before xsi:nil="true"></backed_up_before> <backed_up_after xsi:nil="true"></backed_up_after> <external_id xsi:nil="true"></external_id> <details xsi:nil="true"></details> <query xsi:type="xsd:string">COMP</query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:nil="true"></no_sub_partners> </MachineFindStruct> Machine Get Returns one or more machines. external_id Machine's external ID. alias) . Individual machines can be queried with the id parameter. If both id and search are omitted. user_id User's ID. user_ids List of user ID's to search. keystring Machine's license key string. backed_up_before Returns machines whose last backup was before this dateTime. backed_up_after Returns machines who have backed up since this dateTime. all machines will be returned.Machine API partner_id Partner's ID. or a custom finder can be used to target multiple machines. details Additional details to search off of.

id Machine's ID. For additional information. return Results of Machine MachineResultStruct on page 57. The key used to encrypt your data. search What you are searching for.Request <Get> <id xsi:type="xsd:long"/> <search xsi:type="MachineFindStruct"/> <details soapenc:arrayType="xsd:string[]"/> </Get> Response <GetResponse> <result xsi:type="MachineResultStruct"/> </GetResponse> Elements api_key Partner's key that is required to access the API interface. "default". details The following information is available to query about the machine: Details machine_hash platform encryption encryption_key Description Hash for the machine. Machine platform ("win" or "mac"). see Machine MachineFindStruct on page 60. "aes" or "blowfish"). Current encryption setting ("not set". Example <Get> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> <details soapenc:arrayType="xsd:string[1]" xsi:type="soapenc:Array"> <item>machine_hash</item> </details> </Get> <GetResponse> <return xsi:type="MachineResultStruct"> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="MachineStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">5000</id> <user_id xsi:type="xsd:long">1000</user_id> <alias xsi:type="xsd:string">COMPUTER</alias> 62 Mozy Admin Console API .

Request <Create> <user_id xsi:type="xsd:long"/> <keystring xsi:type="xsd:string"/> <alias xsi:type="xsd:string"/> <quota_desired xsi:type="xsd:long"/> <machine_hash xsi:type="xsd:string"/> <region xsi:type="xsd:string"/> <external_id xsi:type="xsd:string"/> <details soapenc:arrayType="MachineDetailStruct[]"/> </Create> Response <CreateResponse> <return xsi:type="xsd:long"/> </CreateResponse> Elements api_key Partner's key that is required to access the API interface. so you don't have to create a machine through the APIs. This element is required. In most cases. 63 .Machine API <keystring xsi:type="xsd:long">abcde12345</keystring> <created_at xsi:type="xsd:dateTime">2008-01-01T00:00:00Z</created_at> <quota xsi:type="xsd:long">2097152</quota> <quota_used_bytes xsi:type="xsd:long">536870912</quota_used_bytes> <files xsi:type="xsd:long">10000</files> <status xsi:type="xsd:string">active</status> <details soapenc:arrayType="MachineDetailStruct[1]" xsi:type="soapenc:Array"> <item> <key xsi:type="xsd:string">machine_hash</key> <value xsi:type="xsd:string">a1b2c3d4e5</value> </item> </details> <last_backup_at xsi:type="xsd:dateTime">2008-10-01T01:23:00Z</last_backup_at> <external_id xsi:type="xsd:string">m2345</external_id> </item> </results> </return> </GetResponse> Machine Create Creates a machine. This element is required. keystring Available keystring from the user's user group. the machine is created when the client is installed. user_id User's ID.

use -1. quota_desired Desired quota on license or group default. external_id Machine's external id (this field can be used to track an id or value from an external system). If one is not provided. Must be unique among this user's machines. details Additional details to specify for this new machine. region US or EU. The actual quota granted might be less if there is not enough in the group's pool. At least one of the following elements must be passed: • quota • status • source_machine_id • external_id • details Request <Update> <id xsi:type="xsd:long"/> 64 Mozy Admin Console API . all machines will be updated. machine_hash Random 40-char hex string. return ID of the machine that was created. Example <Create> <user_id xsi:type="xsd:long">1000</user_id> <keystring xsi:type="xsd:string">abcde12345</keystring> <alias xsi:type="xsd:string">COMPUTER</alias> <quota_desired xsi:nil="true"></quota_desired> <machine_hash xsi:nil="true"></machine_hash> <region xsi:type="xsd:string">us</region> <external_id xsi:type="xsd:string">m2345</external_id> <details xsi:nil="true"></details> </Create> <CreateResponse> <return xsi:type="xsd:long">5000</return> </CreateResponse> Machine Update Updates one or more machines. or a custom finder can be used to target multiple machines. it is randomly generated. Individual machines can be updated with the id parameter. For example: "MYLAPTOP". If both id and search are omitted. To set unlimited quota for a machine. This element is required.alias Name for the device. Supported keys include "encryption".

To set unlimited quota for a machine.Machine API <search xsi:type="MachineFindStruct"/> <quota xsi:type="xsd:long"/> <status xsi:type="xsd:string"/> <source_machine_id xsi:type="xsd:long"/> <external_id xsi:type="xsd:string"/> <details soapenc:arrayType="MachineDetailStruct[]"/> </Update> Response <UpdateResponse> <return xsi:type="xsd:long"/> </UpdateResponse> Elements api_key Partner's key that is required to access the API interface. external_id Machine's external id (this field can be used to track an id or value from an external system). see Machine MachineFindStruct on page 60. details Additional machine details you want to modify. For additional information. search What you are searching for. id User's ID. For a list of keys. see the details element for Machine Get on page 61. quota Quota grants are limited to what is available for the user group. Example <Update> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"/> <quota xsi:nil="true"></quota> <status xsi:nil="true"></status> <source_machine_id xsi:type="xsd:long">3000</source_machine_id> <external_id xsi:nil="true"></external_id> <details xsi:nil="true"></details> </Update> <UpdateResponse> 65 . source_machine_id Points the current machine to the source machine's manifest and data. Deletes the source machine. use -1. status Active or suspended. return Number of machines updated.

id 66 Mozy Admin Console API . Request <Delete> <id xsi:type="xsd:long"/> <search xsi:type="MachineFindStruct"/> </Delete> Response <DeleteResponse> <return xsi:type="xsd:long"/> </DeleteResponse> Elements api_key Partner's key that is required to access the API interface. <Update> <id xsi:nil="true"></id> <search xsi:type="MachineFindStruct"> <partner_id xsi:nil="true"></partner_id> <user_group_id xsi:nil="true"></user_group_id> <user_id xsi:type="xsd:long">2000</user_id> <alias xsi:nil="true"></alias> <keystring xsi:nil="true"></keystring> <user_ids xsi:nil="true"></user_ids> <backed_up_before xsi:nil="true"></backed_up_before> <backed_up_after xsi:nil="true"></backed_up_after> <external_id xsi:nil="true"></external_id> <status xsi:nil="true"></status> <query xsi:nil="true"></query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:nil="true"></no_sub_partners> </search> <quota xsi:nil="true"></quota> <status xsi:type="xsd:string">suspended</status> <source_machine_id xsi:nil="true"></source_machine_id> <external_id xsi:nil="true"></external_id> <details xsi:nil="true"></details> </Update> <UpdateResponse> <return xsi:type="xsd:long">2</return> </UpdateResponse> Machine Delete Deletes one or more machines. If both id and search are omitted. Individual machines can be deleted with the id parameter. or a custom finder can be used to target multiple machines.<return xsi:type="xsd:long">1</return> </UpdateResponse> Suspend all machines under user 2000. all machines will be deleted.

see Machine MachineFindStruct on page 60. return Number of machines deleted. Example <Delete> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> Deleting all machines with 'COMP' in their alias: <Delete> <id xsi:nil="true"></id> <search xsi:type="MachineFindStruct"> <partner_id xsi:nil="true"></partner_id> <user_group_id xsi:nil="true"></user_group_id> <user_id xsi:nil="true"></user_id> <alias xsi:nil="true"></alias> <keystring xsi:nil="true"></keystring> <status xsi:nil="true"></status> <query xsi:type="xsd:string">COMP</query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:nil="true"></no_sub_partners> </search> </Delete> <DeleteResponse> <return xsi:type="xsd:long">1</return> </DeleteResponse> 67 .Machine API Machine's ID. search What you are searching for. For additional information.

.

user_group_id 69 . Syntax <LicenseStruct> <keystring xsi:type="xsd:string"/> <user_group_id xsi:type="xsd:long"/> <license_type xsi:type="xsd:string"/> <assigned_email_address xsi:type="xsd:string"/> <machine_id xsi:type="xsd:long"/> <external_id xsi:type="xsd:string"/> <quota_desired xsi:type="xsd:long"/> <expires_at xsi:type="xsd:dateTime"/> </LicenseStruct> Elements machine_id Machine's ID. assigned_email_address Email address assigned to the license.Chapter 7 Resource API Major topics include: Topics: • • • • • • • • • • Resource LicenseStruct Resource LicenseFindStruct Resource ResourceStruct Resource LicenseResultStruct Resource GetResources Resource GetLicenses Resource Provision Resource UpdateLicenses Resource Release Resource Transfer Resource LicenseStruct Represents the fields and details of a license record.

Example <LicenseStruct> <keystring xsi:type="xsd:string">abcde12345</keystring> <user_group_id xsi:type="xsd:long">2000</user_group_id> <license_type xsi:type="xsd:string">Desktop</license_type> <assigned_email_address xsi:type="xsd:string">john@example. Syntax <LicenseFindStruct> <partner_id xsi:type="xsd:long"/> <user_group_id xsi:type="xsd:long"/> <license_type xsi:type="xsd:string"/> <status xsi:type="xsd:string"/> <query xsi:type="xsd:string"/> <limit xsi:type="xsd:long"/> <offset xsi:type="xsd:long"/> <no_sub_partners xsi:type="xsd:boolean"/> </LicenseFindStruct> Elements user_group_id User group's ID no_sub_partners Returns results only from the top-most partner. This data structure can be used instead of using the keystring parameter to find or target one or more licenses for GetLicenses/UpdateLicenses method calls. 70 Mozy Admin Console API . quota_desired Amount of quota desired (in GB).User group's ID. license_type Type of license (server/desktop). keystring Machine's license key string. The actual quota assigned might be less if less than the desired amount is available. external_id The license's external id (this field can be used to track an id or value from an external system). expires_at Date when the license expires.com</assigned_email_address> <machine_id xsi:nil="true"></machine_id> <external_id xsi:type="xsd:string">12345</external_id> <quota_desired xsi:type="xsd:long">-1</quota_desired> <expires_at xsi:nil="true">-1</expires_at> </LicenseStruct> Resource LicenseFindStruct Represents a custom license find query.

offset Starting offset used in conjunction with limit. license_type Type of license. name).g. query Case-insensitive search of primary text fields (e. limit Limits the result set (e.. licenses_used Total number of used licenses. partner_ID Partner's ID. Example <LicenseFindStruct> <partner_id xsi:nil="true"></partner_id> <user_group_id xsi:type="xsd:long">2000</user_group_id> <license_type xsi:nil="true"></license_type> <status xsi:nil="true"></status> <query xsi:nil="true"></query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:nil="true"></no_sub_partners> </LicenseFindStruct> Resource ResourceStruct Represents the fields and details of a resource record.g. paging). quota Total amount of quota (in GB). 71 .Resource API status Status of the license (free/reserved/used). Syntax <ResourceStruct> <license_type xsi:type="xsd:string"/> <licenses xsi:type="xsd:long"/> <licenses_reserved xsi:type="xsd:long"/> <licenses_used xsi:type="xsd:long"/> <quota xsi:type="xsd:long"/> <quota_distributed xsi:type="xsd:long"/> <quota_used_bytes xsi:type="xsd:long"/> </ResourceStruct> Elements licenses Total number of licenses..

Example <LicenseResultStruct> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="LicenseStruct[1]" xsi:type="soapenc:Array"> <item> <keystring xsi:type="xsd:string">abcde12345</keystring> <user_group_id xsi:type="xsd:long">2000</user_group_id> <license_type xsi:type="xsd:string">Desktop</license_type> <assigned_email_address xsi:type="xsd:string">john@example. quota_used_bytes Total amount of quota (in GB) that is currently being used. Syntax <LicenseResultStruct> <size xsi:type="xsd:long"/> <results soapenc:arrayType="PartnerStruct[]"/> </LicenseResultStruct> Elements results List from Resource LicenseStruct on page 69. If limit/offset are specified in the Resource LicenseFindStruct on page 70.com</assigned_email_address> 72 Mozy Admin Console API . the size may exceed the actual number of LicensceStruct items in the LicenseResultStruct results. license_type Type of license. size Total number of matched licenses. licenses_reserved Total number of licenses reserved.quota_distributed Total amount of quota (in GB) that has been assigned to machines. Example <ResourceStruct> <license_type xsi:type="xsd:string">Desktop</license_type> <licenses xsi:type="xsd:long">5</licenses> <licenses_reserved xsi:type="xsd:long">3</licenses_reserved> <licenses_used xsi:type="xsd:long">1</licenses_used> <quota xsi:type="xsd:long">20971520</quota> <quota_distributed xsi:type="xsd:long">6291456</quota_distributed> <quota_used_bytes xsi:type="xsd:long">536870912</quota_used_bytes> </ResourceStruct> Resource LicenseResultStruct Represents the returned results of a license record.

Example <GetResources> <partner_id xsi:type="xsd:long">1000</partner_id> <user_group_id xsi:nil="true"></user_group_id> </GetResources> <GetResourcesResponse> <return soapenc:arrayType="ResourceStruct[2]" xsi:type="soapenc:Array"> <item> <license_type xsi:type="xsd:string">Desktop</license_type> <licenses xsi:type="xsd:long">5</licenses> <licenses_reserved xsi:type="xsd:long">3</licenses_reserved> <licenses_used xsi:type="xsd:long">1</licenses_used> <quota xsi:type="xsd:long">20971520</quota> <quota_distributed xsi:type="xsd:long">6291456</quota_distributed> <quota_used_bytes xsi:type="xsd:long">536870912</quota_used_bytes> </item> <item> <license_type xsi:type="xsd:string">Server</license_type> <licenses xsi:type="xsd:long">3</licenses> <licenses_reserved xsi:type="xsd:long">0</licenses_reserved> 73 .Resource API <machine_id xsi:nil="true"></machine_id> </item> </results> </LicenseResultStruct> Resource GetResources Returns resource summary usage for a particular partner or user group. return Returns results of Restore RestoreResultStruct on page 81. user_group_id User group's ID. Request <GetResources> <partner_id xsi:type="xsd:long"/> <user_group_id xsi:type="xsd:long"/> </GetResources> Response <GetResourcesResponse> <return soapenc:arrayType="ResourceStruct[]"/> </GetResourcesResponse> Elements api_key Partner's key that is required to access the API interface. partner_id Partner's ID.

search What you are searching for. If both keystring and search are omitted. or a custom finder can be used to target multiple licenses.<licenses_used xsi:type="xsd:long">2</licenses_used> <quota xsi:type="xsd:long">209715200</quota> <quota_distributed xsi:type="xsd:long">6291456</quota_distributed> <quota_used_bytes xsi:type="xsd:long">5368709120</quota_used_bytes> </item> </return> </GetResourcesResponse> Resource GetLicenses Returns one or more licenses. keystring Resource's keystring. return Results of Resource LicenseResultStruct on page 72. see Resource LicenseFindStruct on page 70. all licenses will be returned. Individual licenses can be queried with the keystring parameter. For additional information. Example <GetLicenses> <keystring xsi:type="xsd:string">abcde12345</keystring> <search xsi:nil="true"></search> </GetLicenses> <GetLicensesResponse> <return xsi:type="LicenseResultStruct"> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="LicenseStruct[1]" xsi:type="soapenc:Array"> <item> <keystring xsi:type="xsd:string">abcde12345</keystring> <user_group_id xsi:type="xsd:long">2000</user_group_id> <license_type xsi:type="xsd:string">Desktop</license_type> 74 Mozy Admin Console API . Request <GetLicenses> <keystring xsi:type="xsd:string"/> <search xsi:type="LicenseFindStruct"/> </GetLicenses> Response <GetLicensesResponse> <result xsi:type="LicenseResultStruct"/> </GetLicensesResponse> Elements api_key Partner's key that is required to access the API interface.

licenses Number of new licenses to add. Not required if partner_id is provided. This is a required element. license_type One of the partner's license types (defaults are Grandfathered/Desktop/Server).Resource API <assigned_email_address xsi:type="xsd:string">john@example. Not required if user_group_id is provided. user_group_id ID of the user group that will receive the new resources. return Returns the results of the Resource LicenseResultStruct on page 72 75 . Any new license keys that are provisioned will be returned in a LicenseResultStruct. The license types need to have the inital capitalization to work correctly.com</assigned_email_address> <machine_id xsi:nil="true"></machine_id> </item> </results> </return> </GetLicensesResponse> Resource Provision Provisions new resources. Desktop (not desktop). quota Number of new quota (in GB) to add. At least one of the following must be passed: • licenses • quota Request <Provision> <partner_id xsi:type="xsd:long"/> <user_group_id xsi:type="xsd:long"/> <license_type xsi:type="xsd:string"/> <licenses xsi:type="xsd:long"/> <quota xsi:type="xsd:long"/> </Provision> Response <ProvisionResponse> <result xsi:type="LicenseResultStruct"/> </ProvisionResponse> Elements api_key Partner's key that is required to access the API interface. For example. partner_id ID of the partner that will receive the new resources.

Example <Provision> <partner_id xsi:type="xsd:long">1000</partner_id> <user_group_id xsi:nil="true"></user_group_id> <license_type xsi:type="xsd:string">Desktop</license_type> <licenses xsi:type="xsd:long">1</licenses> <quota xsi:type="xsd:long">10</quota> </Provision> <ProvisionResponse> <return xsi:type="LicenseResultStruct"> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="LicenseStruct[1]" xsi:type="soapenc:Array"> <item> <keystring xsi:type="xsd:string">abcde12345</keystring> <user_group_id xsi:type="xsd:long">2000</user_group_id <license_type xsi:type="xsd:string">Desktop</license_type> <assigned_email_address xsi:nil="true"></assigned_email_address> <machine_id xsi:nil="true"></machine_id> </item> </results> </return> </ProvisionResponse> Resource UpdateLicenses Updates one or more licenses. all licenses will be updated. Individual licenses can be updated with the keystring parameter. At least one of the following elements must be passed: • external_id • license_type • deliver_emails • assigned_email_address • quota_desired • expires_at • clear_expires_at Request <UpdateLicenses> <keystring xsi:type="xsd:string"/> <search xsi:type="LicenseFindStruct"/> <assigned_email_address xsi:type="xsd:string"/> <quota_desired xsi:type="xsd:long"/> <external_id xsi:type="xsd:string"/> <license_type xsi:type="xsd:string"/> <deliver_emails xsi:type="xsd:boolean"/> <expires_at xsi:type="xsd:dateTime"/> <clear_expires_at xsi:type="xsd:boolean"/> </UpdateLicenses> 76 Mozy Admin Console API . If both keystring and search are omitted. or a custom finder can be used to target multiple licenses.

license_type Type of license. quota_desired Amount of quota desired (in GB). deliver_emails Indicates whether or not license key assignment emails should be sent if the assigned_email_address is set. For additional information. external_id The license's external id (this field can be used to track an id or value from an external system). assigned_email_address Email address that the license will be assigned to. clear_expires_at Specify true to remove the expiration date from a license. search What you are searching for. keystring Resource's keystring.com</assigned_email_address> <quota_desired xsi:type="xsd:long">2097152</quota_desired> <external_id xsi:nil="true"></external_id> <license_type xsi:nil="true"></license_type> <deliver_emails xsi:type="xsd:boolean">true</deliver_emails> </UpdateLicenses> <UpdateLicensesResponse> <return xsi:type="xsd:long">1</return> 77 . The default is false. see Resource LicenseFindStruct on page 70. Example <UpdateLicenses> <keystring xsi:type="xsd:string">abcde12345</keystring> <search xsi:nil="true"></search> <assigned_email_address xsi:type="xsd:string">john@example.Resource API Response <UpdateLicensesResponse> <return type="xsd:long"/> </UpdateLicensesResponse> Elements api_key Partner's key that is required to access the API interface. use -1. return Number of licenses updated. The default is no expiration. expires_at Indicates the date that the license should expire. The actual quota assigned might be less if less than the desired amount is available. To set unlimited quota for a machine. The default is false.

At least one of the following elements must be passed: • licenses • quota Request <Release> <partner_id xsi:type="xsd:long"/> <user_group_id xsi:type="xsd:long"/> <license_type xsi:type="xsd:string"/> <licenses xsi:type="xsd:long"/> <quota xsi:type="xsd:long"/> </Release> Response <ReleaseResponse> <return type="xsd:boolean"/> </ReleaseResponse> Elements api_key Partner's key that is required to access the API interface.</UpdateLicensesResponse> Change the desired activation quota on all unassigned licenses in a specific user group: <UpdateLicenses> <keystring xsi:nil="true"></keystring> <search xsi:type="LicenseFindStruct"> <partner_id xsi:nil="true"></partner_id> <user_group_id xsi:type="xsd:long">2000</user_group_id> <license_type xsi:nil="true"></license_type> <status xsi:nil="true"></status> <query xsi:nil="true"></query> <limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:nil="true"></no_sub_partners> </search> <assigned_email_address xsi:nil="true"></assigned_email_address> <quota_desired xsi:type="xsd:long">1048576</quota_desired> <external_id xsi:nil="true"></external_id> <license_type xsi:nil="true"></license_type> <deliver_emails xsi:type="xsd:boolean">false</deliver_emails> </UpdateLicenses> <UpdateLicensesResponse> <return xsi:type="xsd:long">5</return> </UpdateLicensesResponse> Resource Release Releases (deletes) unused resources. partner_id 78 Mozy Admin Console API .

This is a required element. Desktop (not desktop). Example <Release> <partner_id xsi:nil="true"></partner_id> <user_group_id xsi:type="xsd:long">2000</user_group_id> <license_type xsi:type="xsd:string">Desktop</license_type> <licenses xsi:type="xsd:long">5</licenses> <quota xsi:type="xsd:long">10</quota> </Release> <ReleaseResponse> <return>true</return> </ReleaseResponse> Resource Transfer Transfers unused resources across partners or groups. license_type One of the partner's license types (defaults are Grandfathered/Desktop/Server). Not required if user_group_id is provided.Resource API ID of the partner that will release the unused resources. For example. licenses A positive integer not exceeding current unused license count. quota A positive integer not exceeding current unused gigabyte count. At least one of the following elements must be passed: • license • quota Request <Transfer> <source_partner_id xsi:type="xsd:long"/> <source_user_group_id xsi:type="xsd:long"/> <target_partner_id xsi:type="xsd:long"/> <target_user_group_id xsi:type="xsd:long"/> <license_type xsi:type="xsd:string"/> <licenses xsi:type="xsd:long"/> <quota xsi:type="xsd:long"/> </Transfer> Response <TransferResponse> <return type="xsd:boolean"/> </TransferResponse> 79 . return Returns true or false. user_group_id ID of the user group that will release the unused resources. Not required if partner_id is provided. The license types need to have the inital capitalization to work correctly.

Not required if source_partner_id is provided. target_partner_id ID of the partner that will receive the transfered resources. For example. license_type One of the partner's license types (defaults are Grandfathered/Desktop/Server). source_partner_id ID of the partner that will transfer the unused resources.Elements api_key Partner's key that is required to access the API interface. Desktop (not desktop). Example <Transfer> <source_partner_id xsi:nil="true"></source_partner_id> <source_user_group_id xsi:type="xsd:long">1000</source_user_group_id> <target_partner_id xsi:nil="true"></target_partner_id> <target_user_group_id xsi:type="xsd:long">2000</target_user_group_id> <license_type xsi:type="xsd:string">Desktop</license_type> <licenses xsi:type="xsd:long">5</licenses> <quota xsi:type="xsd:long">10</quota> </Transfer> <TransferResponse> <return xsi:type="xsd:true">true</return> </TransferResponse> 80 Mozy Admin Console API . target_user_group_id ID of the user group that will receive the transfered resources. The license types need to have the inital capitalization to work correctly. quota Positive integer not exceeding current unused quota (in GB). Not required if target_partner_id is provided. Not required if source_user_group_id is provided. return Returns true or false. This is a required element. Not required if target_user_group_id is provided. source_user_group_id ID of the user group that will transfer the unused resources. licenses Positive integer not exceeding current unused license count.

the size may exceed the actual number of /RestoreStruct items in the RestoreResultStruct results. Example <RestoreResultStruct> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="RestoreStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">5000</id> <machine_id xsi:type="xsd:long">5000</machine_id> <request_time xsi:type="xsd:dateTime">2008-01-05T00:00:00Z</request_time> <total_size xsi:type="xsd:long">629145600</total_size> <num_files xsi:type="xsd:long">50</num_files> <num_files_complete xsi:type="xsd:long">40</num_files_complete> 81 . If limit/offset are specified in Restore RestoreFindStruct on page 83.Chapter 8 Restore APi Major topics include: Topics: • • • • Restore RestoreResultStruct Restore RestoreStruct Restore RestoreFindStruct Restore Get Restore RestoreResultStruct Represents the returned results of a restore record. size Total number of matched restores. Syntax <RestoreResultStruct> <size xsi:type="xsd:long"/> <results soapenc:arrayType="RestoreStruct[]"/> </RestoreResultStruct> Elements results Results from Restore RestoreStruct on page 82.

request_time Time the restore was requested. id Restore ID. num_files_complete Number of files that have been restored. Syntax <RestoreStruct> <id xsi:type="xsd:long"/> <machine_id xsi:type="xsd:long"/> <request_time xsi:type="xsd:dateTime"/> <total_size xsi:type="xsd:long"/> <num_files xsi:type="xsd:long"/> <num_files_complete xsi:type="xsd:long"/> <finish_time xsi:type="xsd:dateTime"/> </RestoreStruct> Elements machine_id ID of the machine being restored total_size Total size of the restore (in GB).<finish_time xsi:nil="true"></finish_time> </item> </results> </RestoreResultStruct> Restore RestoreStruct Represents the fields and details of a restore record. Example <RestoreStruct> <id xsi:type="xsd:long">5000</id> <machine_id xsi:type="xsd:long">5000</machine_id> <request_time xsi:type="xsd:dateTime">2008-01-05T00:00:00Z</request_time> <total_size xsi:type="xsd:long">629145600</total_size> <num_files xsi:type="xsd:long">50</num_files> <num_files_complete xsi:type="xsd:long">40</num_files_complete> <finish_time xsi:nil="true"></finish_time> </RestoreStruct> 82 Mozy Admin Console API . finish_time Time the restore was finished. num_files Number of files to be restored.

paging). before Star the search before a particular date. user_id User's ID.g. Example <RestoreFindStruct> <partner_id xsi:nil="true"></partner_id> <user_group_id xsi:nil="true"></user_group_id> <user_id xsi:nil="true"></user_id> <machine_id xsi:nil="true"></machine_id> <after xsi:type="xsd:dateTime">2008-01-01T00:00:00Z</after> <before xsi:type="xsd:dateTime">2008-02-01T00:00:00Z</before> 83 . after Start the search after a particular date. partner_id Partner's ID. limit Limits the result set (e.. Syntax <RestoreFindStruct> <partner_id xsi:type="xsd:long"/> <user_group_id xsi:type="xsd:long"/> <user_id xsi:type="xsd:long"/> <machine_id xsi:type="xsd:long"/> <after xsi:type="xsd:dateTime"/> <before xsi:type="xsd:dateTime"/> <limit xsi:type="xsd:long"/> <offset xsi:type="xsd:long"/> <no_sub_partners xsi:type="xsd:boolean"/> </RestoreFindStruct> Elements machine_id ID of the machine being restored user_group_id User group's ID. no_sub_partners Returns results only from the top-most partner. offset Starting offset used in conjunction with limit. This data structure can be used instead of using the id parameter to find or target one or more restores for Get method calls.Restore APi Restore RestoreFindStruct Represents a custom restore find query.

all restores will be returned. return Results of Restore RestoreResultStruct on page 81. see Restore RestoreFindStruct on page 83. Request <Get> <id xsi:type="xsd:long"/> <search xsi:type="RestoreFindStruct"/> </Get> Response <GetResponse> <result xsi:type="RestoreResultStruct"/> </GetResponse> Elements api_key Partner's key that is required to access the API interface. details For details. search What you are searching for. For additional information. see the Restore RestoreFindStruct on page 83. If both id and search are omitted. Example <Get> <id xsi:type="xsd:long">5000</id> <search xsi:nil="true"></search> </Get> <GetResponse> <return xsi:type="RestoreResultStruct"> <size xsi:type="xsd:long">1</size> <results soapenc:arrayType="RestoreStruct[1]" xsi:type="soapenc:Array"> <item> <id xsi:type="xsd:long">5000</id> <machine_id xsi:type="xsd:long">5000</machine_id> <request_time xsi:type="xsd:dateTime">2008-01-05T00:00:00Z</request_time> 84 Mozy Admin Console API . or a custom finder can be used to target multiple restores.<limit xsi:nil="true"></limit> <offset xsi:nil="true"></offset> <no_sub_partners xsi:nil="true"></no_sub_partners> </RestoreFindStruct> Restore Get Returns one or more restores. id Restore ID. Individual restores can be queried with the id parameter.

Restore APi <total_size xsi:type="xsd:long">629145600</total_size> <num_files xsi:type="xsd:long">50</num_files> <num_files_complete xsi:type="xsd:long">40</num_files_complete> <finish_time xsi:nil="true"></finish_time> </item> </results> </return> </GetResponse> 85 .

.

Required if admin_id is not specified. user_id ID of the intended recipient if sending to a user. Request <deliver> <template xsi:type="xsd:string"/> <user_id xsi:type="xsd:long"/> <admin_id xsi:type="xsd:long"/> <email xsi:type="xsd:string"/> <language xsi:type="xsd:string"/> <details soapenc:arrayType="EmailDetailStruct[]"/> </deliver> Response <DeliverResponse> <return xsi:type="xsd:boolean">true</return> </DeliverResponse> Elements api_key Partner's key that is required to access the API interface. Required if user_id is not specified. please refer to the “Email Templates” module under “Branding /Customization” in the Admin Console. "account_password_forgot"). admin_id ID of the intended recipient if sending to an admin.g. template The name of the template (e. For a current list of available email templates. email Overrides the recipient's email address.Chapter 9 Email API Major topics include: Topics: • Email Deliver Email Deliver Delivers a predefined email template to a specified recipient. language 87 ..

refer to the Admin Console documentation for a complete list). Supported keys include "machine". When specifying "machine" or "restore". When specifying "keys". "user.g. "restore".g. return Returns true or false. details Normally not needed.name" -. but this field allows you to specify predefined template variables you wish to override. you should pass the database id of that object as the value. "keys". Refer to your email templates to see which variables are available and relevant. you should pass the keystrings as the value (separated by commas). force an email to be sent in "pt-BR" rather than "en"). Example <Deliver> <template xsi:type="xsd:string">account_password_forgot</template> <user_id xsi:type="xsd:long">2000</user_id> <admin_id xsi:nil="true"></admin_id> <email xsi:nil="true"></email> <language xsi:nil="true"></language> <details xsi:nil="true"></details> </Deliver> <DeliverResponse> <return>true</return> </DeliverResponse> 88 Mozy Admin Console API .Overrides the recipient's language preference (e. plus any standard template variables (e.

Sign up to vote on this title
UsefulNot useful