How do I install or enable the Jira REST API?

Rob Marston June 4, 2012

I've read the documentation and I'm still a little confused as to how I begin using the Jira REST API. I am a new member of my company's Jira instance and they have tasked me with developing an external plugin which leverages some of the data available with the API. I don't know too much about how the software is set up other than it appears that we are not hosting it in-house. I'm very familiar with how REST endpoints work, JSON, and all of that I just don't know if everything is already accessible and if so, at what URL.

Thank you in advance!

3 answers

1 accepted

4 votes
Answer accepted
Jobin Kuruvilla [Adaptavist]
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
June 4, 2012

You can find the REST specification here: http://docs.atlassian.com/jira/REST/latest/

Just access the urls in browser to see if it is enabled. If not, make sure the 'Allow Remote API Calls' is turned ON under Administration > General Configuration.

Rob Marston June 4, 2012

I don't see General Configuration on my Administration page, all I see is Projects, Project Categories, User Management, Look and Feel, Tabs, Help and Support, and Jira Import. Also, which URLs should I try? My instance of Jira is hosted at https://snydla.jira.com/, does that mean https://syndla.jira.com/jira/rest/api/2/component/10000 or any of the other exmaples should work?

Thanks for your help.

Rob Marston June 4, 2012

That did the trick, thank you!

Jobin Kuruvilla [Adaptavist]
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
June 4, 2012

Try https://syndla.jira.com/rest/api/2/component/10000

For OnDemand, RPC calls should be ON by default.

Ron Marisie December 9, 2015

That is Administration>General Configuration>Accept remote API calls

Like Deleted user likes this
2 votes
d hofbauer February 2, 2017

If you are using JIRA v7, see what  @Nic Brough [Adaptavist] stated here. The REST API is enabled by default since Version 7.

 

0 votes
Roma shah July 9, 2013

Hey

I am trying my REST api of hosted instance but its giving me 401 error even though i put basic headers

https://fusionbussolutions.atlassian.net/rest/api/2/issue/createmeta

Dalibor Musil January 7, 2016

not an answer, put a new question please

Suggest an answer

Log in or Sign up to answer