Page tree

You are on the Xray Cloud documentation. If you are looking for Xray Server documentation, you can find it in this page

Skip to end of metadata
Go to start of metadata
Xray uses Jira issues to implement Test, Pre-Condition, Test Set, Test Execution and Test Plan entities. Therefore, these entities may be created or updated using Jira's native REST API, based on Jira authentication.

Xray itself provides a REST API, with endpoints specifically made for dealing with test management. Requests made to Xray's REST API must be authenticated using a Client Id and a Client Secret, both of which are based on an API Key created for a specific user in Xray Global Settings: API Keys global settings.
Thus, the first step for you is to obtain the token based on the Client Id and Client Secret of your assigned API Key. You can then use that to make whatever requests to the Xray Cloud.

Please note

The REST API base URL for all endpoints is

Feel free to contribute!

Xray is used and integrated with many different platforms. If you have the time and know-how, feel free to contribute an API implementation in your preferred language (e.g., Java, .NET, JavaScript, etc.). We'd be happy to include links to your contribution (smile)

  • No labels