Zimbra REST API Reference: Difference between revisions
Line 20: | Line 20: | ||
The following describes the components of the REST command: | The following describes the components of the REST command: | ||
{| | {|cellpadding="5" cellspacing="0" border="1" | ||
|Command Component | |style="background-color:#ffffcc;"|Command Component | ||
|Description | |style="background-color:#ffffcc;"|Description | ||
|- | |- | ||
| | | |
Revision as of 18:41, 16 January 2010
Zimbra exposes its data via a REST API. This document is the reference for that functionality.
REST (REpresentational State Transfer) is an approach for building application services that make resources available via a URL. For example, the following REST command retrieves all inbox items as a simple RSS feed:
http://localhost:7070/home/user1/inbox.rss
Learn more about REST at the Wikipedia article Representational State Transfer.
Command Format
The format of a Zimbra REST command is:
{protocol}://{host}:{port}/home/[~][{username}]/{object}?{query-params}
The following describes the components of the REST command:
Command Component | Description |
Common Parameters
Methods
The API supports the following methods to retrieve Zimbra data.