Rest api » History » Revision 15

« Previous | Revision 15/102 (diff) | Next »
Eric Davis, 2010-10-21 06:23
Added a bunch of content about the different resource types in Redmine and their API status

Redmine API

Redmine exposes some of its data through a REST API. This API provides access and basic CRUD operations (create, update, delete) for the resources described below.

Most of the time, the API requires authentication. This is done via HTTP Basic authentication using the regular Redmine accounts. To enable this API-style authentication, check Enable REST API in Administration -> Settings -> Authentication.

At the time of writing, the API is only available in trunk (see r3310, r3313).

At the time of writing, the API is available in both the trunk and the stable-1.0 branch. See CheckingoutRedmine

API Description

Status legend:

  • Stable - feature complete, no major changes planned
  • Beta - usable for integrations with some bugs or missing minor functionality
  • Alpha - major functionality in place, needs feedback from API users and integrators
  • Prototype - very rough implementation, possible major breaking changes mid-version. Not recommended for integration
  • Planned - planned in a future version, depending on developer availability
  • Unplanned - no plans for an api in a near version.
Resource Status Notes
Issues Beta Usable with some bugs and rough edges.
Projects Beta Usable with some bugs and rough edges.
Users Planned 1.1
Wiki Pages Planned 1.1
Files Planned 1.1
News Prototype, Planned 1.1 Prototype implementation for index only
Auth Sources Unplanned
Boards Unplanned Forums. See Messages for actual threads and posts
Documents Unplanned Might be merged with Files
Enumerations Unplanned
Groups Unplanned
Issue Categories Unplanned
Issue Relations Unplanned
Issue Statuses Unplanned
Journals Unplanned Issue notes and updates (history)
Members Unplanned
Messages Unplanned Forum posts
Query Unplanned Custom issue queries
Repositories Unplanned
Roles Unplanned
Settings Unplanned
TimeEntries Unplanned
Trackers Unplanned
Versions Unplanned
WikiContents Unplanned History of a wiki page. May be merged into the main Wiki API

API Usage

Updated by Eric Davis over 12 years ago · 15 revisions locked