You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Current »

The Xray REST API provides endpoints specifically made for dealing with heavier or time-consuming operations.

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

LocationRegionEndpoint
GlobalAll Xray cloud across regionshttps://xray.cloud.getxray.app/
USAConsists of USA regionhttps://us.xray.cloud.getxray.app/
EUConsists of Europe (Frankfurt) regionhttps://eu.xray.cloud.getxray.app/
AustraliaConsists of Australia (Sydney) regionhttps://au.xray.cloud.getxray.app/



 


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