Project

General

Profile

Plugins Directory » Redmine Extended API

 Author: Jan Catrysse
Website: https://github.com/jcatrysse/redmine_extended_api
Code repository: https://github.com/jcatrysse/redmine_extended_api.git
Registered on: 2025-11-14 (about 17 hours ago)
Current version: 0.0.2
Compatible with: Redmine 6.1.x, 6.0.x, 5.1.x, 5.0.x
User ratings:   (0)

Redmine Extended API

ATTENTION: ALPHA STAGE

This plugin exposes Redmine's REST API under an alternate base path and unlocks write access for administrative resources that are read-only in vanilla Redmine. Every request keeps the native controllers, permission checks, and response formats, so it behaves exactly like Redmine would if those endpoints were public.

Overview

  • /extended_api is a drop-in proxy of the core REST API. Anything that works under the default paths continues to work unchanged when you prepend the new base path.
  • Additional write operations are enabled for catalogue-like resources (roles, custom fields, issue statuses, trackers, and enumerations). The plugin reuses the built-in controllers, so validation rules and workflows stay identical to the web UI.
  • Optional integrations (for example redmine_depending_custom_fields) automatically surface their own REST attributes whenever they expose compatible controllers.

Core vs. extended coverage

Resource category Core Redmine behaviour What the plugin adds Notes
Issues, projects, time tracking, files, wiki, news, memberships, queries, search, repositories, etc. Already exposed through the official REST API. Proxied verbatim under /extended_api. Use this when you want an isolated gateway without touching existing integrations.
Administrative catalogs: roles, trackers, issue statuses, enumerations, custom fields Limited to HTML UI in core. No REST write endpoints. Adds authenticated POST/PUT/PATCH/DELETE plus enriched payloads while keeping Redmine's permission model. These endpoints live exclusively under /extended_api.
Third-party plugins with API-aware controllers (e.g. redmine_depending_custom_fields) Varies per plugin. Their API actions are automatically available when routed through /extended_api. The extended API exposes any additional attributes permitted by the plugin.

If you only need core behaviour, keep using the official REST endpoints. The plugin does not override or patch the original routes.

All new endpoints will have a recognisable JSON /XML payload:

{"extended_api":{"mode":"extended","fallback_to_native":false}}

Installation notes

Clone this repository into your Redmine plugins directory:

cd /path/to/redmine/plugins
git clone https://github.com/jcatrysse/redmine_extended_api.git

Restart Redmine.
No database migrations are required at this stage.

Atom

Changelog

0.0.2 (2025-11-14)

Compatible with Redmine 6.1.x, 6.0.x, 5.1.x, 5.0.x.