REST API

The REST API provides a way for external applications to access information stored in Redmine.
It allows you to create, read, update, and delete various objects such as issues and Wiki pages.

Developing Applications Using the REST API

For details, please refer to the following reference:

How to Enable the API

To enable the REST API, log in as a user with administrator privileges and follow these steps:

  1. Open Administration → Settings.
  2. Go to the API tab
    (in Redmine 3.1 and earlier, this is the Authentication tab).
  3. Turn on Enable REST web service.
  4. Click Save to apply the settings.
API Enable

Obtaining an API Key

When using the REST API, authentication can be performed using an API key or Basic authentication.

To obtain your API key:

  1. Click My account in the upper-right corner of the screen.
  2. On the My account page, click Show in the API access key section in the sidebar on the right.
api key

Example Applications Using the REST API

RedminePM

A client application that allows you to manage Redmine issues from iPad, iPhone, and Android devices.

API Redminepm
← Back to Glossary Index