Requests made to Xray's REST API (and also the GraphQL 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 global REST API base URL for all endpoints is https://xray.cloud.getxray.app/ .
For deployments that use data residency, please use the url that matches your Xray region for more performant API.
Available endpoints by zone
| Location | Region | Endpoint |
|---|---|---|
| Global | All Xray cloud across regions | https://xray.cloud.getxray.app/ |
| USA | Consists of USA region | https://us.xray.cloud.getxray.app/ |
| EU | Consists of Europe (Frankfurt) region | https://eu.xray.cloud.getxray.app/ |
| Australia | Consists of Australia (Sydney) region | https://au.xray.cloud.getxray.app/ |
API Rate Limit
As Jira, Xray limits the rate for API requests to ensure that services are reliable and responsive to customers.
Xray Standard has limit of 300 per 5 minutes & Xray Enterprise of 1000 per 5 minutes. Please check Jira documentation to learn more about Jira Cloud API Rate Limit.
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 