Zimbra REST API Reference: Difference between revisions
Line 15: | Line 15: | ||
<pre> | <pre> | ||
{protocol}://{host}:{port}/home/ | {protocol}://{host}:{port}/home/{user}/{object}?{query-params} | ||
</pre> | </pre> | ||
Line 21: | Line 21: | ||
{|cellpadding="5" cellspacing="0" border="1" | {|cellpadding="5" cellspacing="0" border="1" | ||
|style="background-color:#ffffcc;"| | |style="background-color:#ffffcc;"|'''Component''' | ||
|style="background-color:#ffffcc;"|Description | |style="background-color:#ffffcc;"|'''Description''' | ||
|- | |- | ||
|<code>protocol</code> | |||
| | | | ||
|- | |||
|<code>host</code> | |||
| | |||
|- | |||
|<code>port</code> | |||
| | |||
|- | |||
|<code>user</code> | |||
| | |||
|- | |||
|<code>object</code> | |||
| | |||
|- | |||
|<code>query-params</code> | |||
| | | | ||
|} | |} |
Revision as of 18:43, 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/{user}/{object}?{query-params}
The following describes the components of the REST command:
Component | Description |
protocol
|
|
host
|
|
port
|
|
user
|
|
object
|
|
query-params
|
Common Parameters
Methods
The API supports the following methods to retrieve Zimbra data.