Contents:

High Level Design

Web UI

REST API

Introduction

The CloudSync REST API is a web-accessible, resource-oriented API that exposes operations on the key entities of the service.

The base URL of all REST API operations is the URL of the cloudsync app, plus /api/rest/. For example:

http://example.org/cloudsync/api/rest/

Operations on Tasks

createTask

POST /cloudsync/api/rest/tasks

listTasks

GET /cloudsync/api/rest/tasks

getTask

GET /cloudsync/api/rest/tasks/{id}

updateTask

PUT /cloudsync/api/rest/tasks/{id}

deleteTask

DELETE /cloudsync/api/rest/tasks/{id}

Operations on Task Logs

• list all task logs
• get information about a single task log
• delete a task log

Operations on Sets

• create a set
• list all sets
• get information about a single set
• update a set
• delete a set

Operations on Stores

• create a store
• list all stores
• get information about a specific store
• update a store
• delete a store

Operations on Global Configuration

• get all global configuration values
• set a specific global configuration value

Operations on User Preferences

• get all user preferences values
• set a specific user preference value

Operations on System Logs

• list log messages by datetime range and severity level