/agile vs /api REST Endpoints

Matthew Brand March 28, 2018

There are two sets of API docs available for JIRA Cloud:

https://developer.atlassian.com/cloud/jira/platform/rest/
https://developer.atlassian.com/cloud/jira/software/rest/

I'm confused which set of endpoints I'm supposed to be using for what. Is it just whatever gets me the information I need?

Additionally, I'm trying to develop an add-on and I'm able to connect fine to the endpoints that are /rest/api but not /rest/agile. I get an error saying:

Failed to validate origin

Is there some extra security hoop I need to jump through for some of these endpoints?

1 answer

1 vote
Deleted user March 28, 2018

Hey there Matthew,

https://developer.atlassian.com/cloud/jira/platform/rest/
https://developer.atlassian.com/cloud/jira/software/rest/

You can use either one in Cloud. The platform ones are the "Core" Jira features like Issues and Projects whereas the /software ones are software specific items like boards and sprints

Failed to validate origin

If you're accessing this from an add-on you'll want to make sure you descriptor has the right permissions. You'll need to add something like a READ scope to your add on https://developer.atlassian.com/cloud/jira/platform/scopes/

Hope that helps!

Cheers,

Mark C

Matthew Brand March 29, 2018

Thanks for the clarification on the two APIs.

Regarding READ scope, I do have that in my atlassian-connect.json file

"scopes": [
"read"
]

And, it's working for the /rest/api endpoints, just not the /rest/agile ones. So, I think my atlassian-connect.json file is setup correctly.

Matthew Brand March 29, 2018

Welp, I feel dump. It turns out it's working fine. I was accidentally using a board ID from a different JIRA instance. Now that I'm providing a correct value it's working. So, it's just a bit confusing of an error message.

Suggest an answer

Log in or Sign up to answer