Redmine

h1. 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.

h2. Authentication

Most of the time, the API requires authentication. To enable the API-style authentication, you have to check *Enable REST API* in Administration -> Settings -> Authentication. Then, authentication can be done in 2 different ways:

* using your regular login/password via HTTP Basic authentication.

* using your API key which is a handy way to avoid putting a password in a script. The API key may be attached to each request as a "key" parameter or it may be passed in as a username with a random password. You can find your API key on your account page ( /my/account ) when logged in, on the right-hand pane of the default layout.

h2. 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  |_.Availability|

|[[Rest_Issues|Issues]]         | Beta        | Usable with some bugs and rough edges.  | 1.0 |

|[[Rest_Projects|Projects]]     | Beta        | Usable with some bugs and rough edges.  | 1.0 |

|[[Rest_Users|Users]]           | Planned | | 1.1 |

|[[Rest_TimeEntries|TimeEntries]]           | Planned | | 1.1 |

|[[Rest_WikiPages|Wiki Pages]]  | Planned | | |

|[[Rest_Files|Files]]           | Planned | | |

|[[Rest_News|News]]             | Prototype, Planned | Prototype implementation for @index@ only | |

|[[Rest_AuthSources|Auth Sources]]           | Unplanned | | |

|[[Rest_Boards|Boards]]           | Unplanned | Forums. See Messages for actual threads and posts | |

|[[Rest_Documents|Documents]]           | Unplanned | Might be merged with Files | |

|[[Rest_Enumerations|Enumerations]]           | Unplanned | | |

|[[Rest_Groups|Groups]]           | Unplanned | | |

|[[Rest_IssueCategories|Issue Categories]]           | Unplanned | | |

|[[Rest_IssueRelations|Issue Relations]]           | Unplanned | | |

|[[Rest_IssueStatuses|Issue Statuses]]           | Unplanned | | |

|[[Rest_Journals|Journals]]           | Unplanned | Issue notes and updates (history) | |

|[[Rest_Members|Members]]           | Unplanned | | |

|[[Rest_Messages|Messages]]           | Unplanned | Forum posts| |

|[[Rest_Query|Query]]           | Unplanned | Custom issue queries | |

|[[Rest_Repositories|Repositories]]           | Unplanned | | |

|[[Rest_Roles|Roles]]           | Unplanned | | |

|[[Rest_Settings|Settings]]           | Unplanned | | |

|[[Rest_Trackers|Trackers]]           | Unplanned | | |

|[[Rest_Versions|Versions]]           | Unplanned | | |

|[[Rest_WikiContents|WikiContents]]           | Unplanned | History of a wiki page. May be merged into the main Wiki API| |

h2. API Usage in various languages

* [[Rest_api_with_ruby|Ruby]]

* [[Rest_api_with_php|PHP]]

* [[Rest_api_with_python|Python]]