API Documentation

LOBSTA extends Redmine and provides some of its data through a REST API. This API provides access and basic CRUD operations (create, update, delete) for selected resources. The API supports both XML and JSON formats.

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 -> API. Then, authentication can be done in 2 different ways:

• using regular login/password via HTTP Basic authentication.
• using an API key without the need of a password.

The API key may be attached to each request in one of the following ways:

• passed in as a key parameter
• passed in as a username with a random password via HTTP Basic authentication
• passed in as a X-Redmine-API-Key HTTP header

You can find your API key in the sidebar of your account page (/my/account) when logged in.

OpenAPI Docs

info

We're currently working on an OpenAPI based API specification.
Until available please get in touch for more development related information.