CloudSync Project
CloudSync 1.1.x (Current Release)
CloudSync 1.0.x
On this page:
Table of Contents |
---|
All API operations require authentication except GET serviceInfo and POST serviceInit.
Two forms of authentication are supported across the API:
...
Note | ||
---|---|---|
| ||
With either form of authentication, credentials are sent over the network in a way that is trivial for attackers to intercept. Therefore, if traffic to the REST API is going over a public network, you are strongly advised to communicate with the service over HTTPS. |
All API operations can be invoked by any authenticated user except POST user, PATCH user, and DELETE user. The particular rules that apply to these operations are explained in their documentation below.
Except where indicated otherwise, all operations in this API support two media types for request and response payloads:
...
The exact media type used for a given operation depends on the type of data being sent or received. The #Formats section of this document provides a complete list of media types and their definitions.
Tip | ||
---|---|---|
| ||
Most browsers won't natively show content in the custom XML and JSON-based media types defined by this API. But if you add For example, you might point your browser to |
This API uses the following methods for all operations:
...
Tip | ||
---|---|---|
| ||
Some HTTP clients have limited support for the less frequently used DELETE and PATCH methods. This API supports the |
The cloudsync-client.js library was written to support CloudSync's default user interface, and can be found at js/cloudsync-api.js
in a deployed CloudSync instance. All operations documented below are supported through use of this library, which exposes the service using an RPC-style syntax.