Zimbra REST API Reference: Difference between revisions
No edit summary |
|||
Line 11: | Line 11: | ||
== Command Format == | == Command Format == | ||
The format of a Zimbra REST command is: | |||
<pre> | |||
{protocol}://{host}:{port}/home/[~][{username}]/{object}?{query-params} | |||
</pre> | |||
The following describes the components of the REST command: | |||
{| | |||
|Command Component | |||
|Description | |||
|- | |||
| | |||
| | |||
|} | |||
== Common Parameters == | == Common Parameters == |
Revision as of 18:40, 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.