JIRA Agile REST API

[Peter Dittman]

Where did the Greenhopper (ok, JIRA Agile) REST API documentation go?

I found the JIRA REST API Browser:

https://developer.atlassian.com/display/DOCS/Using+the+REST+API+Browser

And it shows me a nice little tool to browse the API, but all the JSON examples are gone! nevermind the output of the API calls...

Did they move someplace else? are they being migrated to a richer doc set? or is it all self-documenting and I need to start reading the code?

[pschaff01 · Accepted solution]

Hi Peter,

You can find information in the following pages:

https://developer.atlassian.com/display/JIRADEV/JIRA+Agile+Development

There is also an improvement request to document REST API for Agile, which you can access in this link:

https://jira.atlassian.com/browse/GHS-6786

Cheers,

Pietro Schaff

[Peter Dittman]

Pietro,

thanks for the additional information. Still looking for something other than the REST Browser - while it's helpful for locally-hosted solutions, it's still pretty tedious to figure out what's being returned by the API by sampling with different inputs... Anything you guys can do to document the API would be appreciated.

-P

[Taiwo Akindele]

Hi Peter,

It appears you can still find some of that information here: https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Tutorials

[David Grierson]

His question is specifically about the JIRA Agile REST API documentation - those tutorials don't provide any information about JIRA Agile.

[Andrew]

We're pleased to announce that JIRA Agile now has a public REST API. The new officially supported REST API includes a number of improvements over the old private JIRA Agile REST APIs:

• New resources — We've added a number of new resources to help you interact with JIRA Agile, like the epic and sprint resources.
• Online documentation — You don't need to mess around looking at private internal API calls anymore. The documentation is available online and will be updated with each release.
• New documentation theme — The documentation is now easier to parse with expandable sections for resources and better styling.

Check out the documentation for the latest version here: https://docs.atlassian.com/greenhopper/REST/cloud/ 

If you are currently using the private JIRA Agile REST API, see the instructions below:

• If you have a Connect add-on — Be aware that the resources that are marked as private in JIRA Agile REST Scopes have been deprecated. These private resources will no longer be whitelisted on the 1st November 2015. You must migrate to the new public REST API before this date. Note, there is feature parity between the whitelisted private resources and the new public REST resources.
• If you have a P2 add-on — Be aware that the private JIRA Agile REST API will remain experimental and may break at any time. You can continue to use the private API, but we recommend that you migrate to the new public REST API. Note, feature parity does not exist between the private and public REST APIs, and we cannot promise that there will be feature parity in future.

If you have problems using the new JIRA Agile REST API, create an issue in the ACJIRA project on ecosystem.atlassian.net (not the issue tracker shown at the top of this page).

Andrew Lui
Technical writer, JIRA ecosystem