Zimbra REST API Reference: Difference between revisions
Line 50: | Line 50: | ||
http://localhost:7070/home/~/inbox.rss | http://localhost:7070/home/~/inbox.rss | ||
</pre> | </pre> | ||
|- | |- | ||
|<code>object</code> | |<code>object</code> | ||
Line 56: | Line 55: | ||
|- | |- | ||
|<code>query-params</code> | |<code>query-params</code> | ||
| | |A list of command-specific URL query parameters. See the specific command for a list of the required and optional parameters. | ||
|} | |} | ||
Revision as of 18:53, 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
|
The transport protocol, for example, http .
|
host
|
The host name or IP address of the Zimbra Collaboration Suite server |
port
|
The port number, for example, 7070. |
user
|
The user. To load an explicit user account, specify the user in one of the following formats:
http://localhost:7070/home/john.doe@mydomain.com/inbox.rss You can also use "~" as shortcut to the currently authenticated user. For example: http://localhost:7070/home/~/inbox.rss |
object
|
|
query-params
|
A list of command-specific URL query parameters. See the specific command for a list of the required and optional parameters. |
Common Parameters
Methods
The API supports the following methods to retrieve Zimbra data.