ChiliProject is not maintained anymore. Please be advised that there will be no more updates.

We do not recommend that you setup new ChiliProject instances and we urge all existing users to migrate their data to a maintained system, e.g. Redmine. We will provide a migration script later. In the meantime, you can use the instructions by Christian Daehn.

REST API

ChiliProject v1.x

Chiliproject v1.x's REST API is almost identical to Redmine 1.1.0 REST API (with two little exceptions - will be documented later).

ChiliProject v2.x

Chiliproject v2.x's REST API is almost identical to Redmine 1.1.0 REST API (with two little exceptions - will be documented later).

Proposed API Changes

The current REST API will be undergoing some major changes. The internal structure will be rewritten but the external API shouldn't change much. Any changes will be documented. See also: https://www.chiliproject.org/boards/2/topics/67

Library access

Accessing the API can be done using any HTTP client. The API is designed to follow the ActiveResource style common to other Ruby on Rails applications.

Specialized libraries for different programming languages:

REST API Examples

This shows how you can use the REST API from a command line with curl. You can translate into the code of your choice.

curl -v \
  --header 'X-ChiliProject-API-Key: 0123456789abcdef012345f10b73285fd681be92' \
  http://localhost/chili/time_entries.json?period_type=1&period=current_month

curl -v \
  --header 'X-ChiliProject-API-Key: 0123456789abcdef012345f10b73285fd681be92' \
  http://localhost/chili/issues.json

curl -v \
  --header 'X-ChiliProject-API-Key: 0123456789abcdef012345f10b73285fd681be92' \
  http://localhost/chili/issues/123.json?include=journals