Project maintained by zapadi Hosted on GitHub Pages — Theme by mattgraham


redmine-net-api is a library for communicating with a Redmine project management application


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 in one of the following way:

User Impersonation

As of Redmine 2.2.0, you can impersonate user through the REST API by setting the X-Redmine-Switch-User header of your API request. It must be set to a user login (eg. X-Redmine-Switch-User: jsmith). This only works when using the API with an administrator account, this header will be ignored when using the API with a regular user account.

If the login specified with the X-Redmine-Switch-User header does not exist or is not active, you will receive a 412 error response.


The API is released under Apache 2 open-source license. You can use it for both personal and commercial purposes, build upon it and modify it.