Zimbra REST API Reference: Difference between revisions
No edit summary |
No edit summary |
||
Line 9: | Line 9: | ||
Learn more about REST at the Wikipedia article [http://en.wikipedia.org/wiki/Representational_State_Transfer Representational State Transfer]. | Learn more about REST at the Wikipedia article [http://en.wikipedia.org/wiki/Representational_State_Transfer Representational State Transfer]. | ||
== Overview == | |||
== Command Format == | == Command Format == | ||
Line 68: | Line 69: | ||
|A list of command-specific URL parameters. See the specific command for a list of the required and optional parameters. | |A list of command-specific URL parameters. See the specific command for a list of the required and optional parameters. | ||
|} | |} | ||
=== Response Formats === | |||
XYZ | |||
=== Authentication === | |||
XYZ | |||
== Methods == | == Methods == | ||
Line 84: | Line 93: | ||
[[ZCS_6.0:Zimbra REST API Reference:Get_Folder|Get Folder]] | [[ZCS_6.0:Zimbra REST API Reference:Get_Folder|Get Folder]] | ||
Revision as of 19:33, 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.
Overview
Command Format
The format of a Zimbra REST command is:
{protocol}://{host}:{port}/home/{user}/{object}?{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 a shortcut to the current user. For example: http://localhost:7070/home/~/inbox.rss |
object
|
Designates the object to perform the command against. This might be a folder (such as inbox or drafts) or omitted (to download a specific item). If omitted, the query parameters will provide the information the command requires.
For example, to download the inbox folder as XML: http://localhost:7070/home/john.doe/inbox.rss For example, to download an item: http://localhost:7070/home/john.doe/?id=657 |
params
|
A list of command-specific URL parameters. See the specific command for a list of the required and optional parameters. |
Response Formats
XYZ
Authentication
XYZ
Methods
The API supports the following methods to retrieve Zimbra data.