Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

getting XRAY steps with API

i would like to get the steps done in an xray issue,   so later on i can modify them i am following the documentation from

 and using 

https://my_site/rest/raven/1.0/api/test/TES-3/step  but my responds is 404  

i created an API TOKEN that i can use in the normal Jira api calls, for example if i do 

https://my_site/rest/api/2/issue/TES-3 and do get a json with information, but looks like in the directory doesn't have the information of the steps, or the other precondition, test sets etc...  so i went to look for the xray API, but they say that is also basic that i can use jira API, .... i am missing something? xray does have a different authorization?  i am using the free version not sure if that might have restrictions?  


thanks guys =?

1 answer

Hi @Demiank100 ,

it seems you're looking at Xray Server (on Jira server) documentation. 

The proper documentation for Xray Cloud is this one:


It requires you to use the GraphQL API, which is the correct API for that in cloud.

You can see some usage examples in the postman collections available in this open-source project :)  -



thanks Sergio,  i was able to create my API on the xray application(not Jira, that is a diferent thing and maybe that what i was having confuse to begging with), and did a rest api to

with my cliend_id and my client_secret, got 200 and got the token =)


but now? what do i do?  how can i retrieve for example the steps on an issue? or update them?

I would highly recommend you to have a look at the postman collections that I've shared with you as it provides concrete examples :)

Here is an example of a GraphQL request for that:


HTTP GET request to with the body content

{ getTest(issueId: "1234") { steps { id data action result attachments { id filename } } }}


you need to know the issueId (it's not the issue key) though. For that you need to either obtain it from the Jira HTTP issue creation request.. or you need to make a Jira HTTP request for that. For the former, I've an example in the postman collection under GraphQL>tests>create folder. For the later, you can see here:

Note: the GraphQL documentation is somehow interactive; it also provides usage examples.

thanks for posting the git  with those examples, they are great  (and easier to follow that the xray documentation =)  thanks,  got it working.

you're welcome :) it took me a while to prepare them but I think they help in cases like this ;)


they SUPER HELP!!!!

Like Sergio Freire likes this

Suggest an answer

Log in or Sign up to answer
Site Admin
Community showcase
Published in Marketplace Apps & Integrations

🤺 Atlympic Event: Partnerships

Hello Community!  Quick disclaimer: We are running a contest on Community (The Atlympics!) from July 23rd - August 8th of 2021. If you are interested in participating in this contest (prizes! ...

56 views 0 2
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you