Feature #5901

REST API to expose the Redmine version

Added by Eric Davis about 7 years ago. Updated almost 2 years ago.

Status:NewStart date:2010-07-18
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:REST API
Target version:Candidate for next major release
Resolution:

Description

After reading Alexey Skor's forum post about the API versions, I think it would make 3rd party development easier if Redmine had a REST API method to find out what version of Redmine the server is running.

That way a client can check to see if the server supports the API requests it needs (e.g. 1.0+ has an issues API, 0.9 doesn't).

Thoughts?

redmine_config_dialog.png (28.6 KB) Alex Last, 2010-11-29 21:44


Related issues

Related to Redmine - Feature #5977: "check status" feature to verify validity of Redmine inst... New 2010-07-27
Related to Redmine - Feature #794: Restrict display of version number in footer Closed 2008-03-06
Duplicated by Redmine - Feature #8145: API: Redmine version Closed 2011-04-14

History

#1 Updated by Jean-Baptiste Barth about 7 years ago

Agreed, it's a must-have.

#2 Updated by Eric Davis over 6 years ago

  • Assignee deleted (Eric Davis)

I am stepping down from working on Redmine. If someone else is interesting in working on this issue, feel free to reassign it to them.

Eric Davis

#3 Updated by Alex Last over 6 years ago

this would be a very useful feature for my application. I could add a "ping" button to "Redmine server" dialog and show if the server is
1) up and running
2) has REST API enabled
3) the server version info

#4 Updated by Etienne Massip about 6 years ago

  • Target version set to Candidate for next major release

#5 Updated by Ivan Cenov almost 4 years ago

+1

#6 Updated by André Jonsson over 3 years ago

Or even better, an API to request what API resources are supported by the server.
Calling it would return a list similar to the table on the page Rest_api, primarily the "resource" and "status" columns.

Perhaps a separate issue...

#7 Updated by Go MAEDA about 3 years ago

Displaying a version number was disabled because of security concerns since Redmine 0.8(#794). I think it should not be exposed through REST API for the same reason.

#8 Updated by Nicolas Rodriguez over 2 years ago

I think it should not be exposed through REST API for the same reason.

Even after authentication via API token?

#9 Updated by Alex Last over 2 years ago

Redmine 3.x broke backward compatibility again - the date format used by it is different from Redmine 2.6.2:

From redmine 2.6.0: "updated_on":"2015-01-23T00:15:24Z"
From redmine 3.0.0: "updated_on":"2015-01-29T10:06:19.000Z"

one of our users submitted this bug report: https://github.com/taskadapter/redmine-java-api/pull/175

if we could query Redmine to see its version, we could pick the right date format instead of guessing... now we will have to check "are there 3 more digits after this and before that?"..

another (actually better!) option would be querying Redmine to see what date format it uses for long dates and short dates - because this is what the library actually cares about. I will submit this as a separate feature request.

#11 Updated by Alex Last over 2 years ago

another example: I see 'spent_hours' default value for new issues created through REST API is NULL for Redmine 3.0.0 and is equal to "0.0" for Redmine 2.6.2.
there is no way for the java api library to detect the Redmine version (well, unless we start parsing 'redmine/admin/info' HTML page, which is definitely not what we want to do).

#12 Updated by Go MAEDA over 2 years ago

  • Related to Feature #794: Restrict display of version number in footer added

#13 Updated by shadowbq - almost 2 years ago

Not the best route implementation, but will bridge the gap for people that dont want to wait another five years..

https://www.redmine.org/plugins/redmine_info_api

https://github.com/shadowbq/redmine_info_api

  1. Download plugin
  2. Extract to your Redmine into vendor/plugins/redmine_info_api
  3. Restart web server
  4. request with admin user & basic auth https://redmine.example.com/adminapi/info.json

Also available in: Atom PDF