Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
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 The Xray REST API provides endpoints specifically made for dealing with test management. 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.

titlePlease note

The REST API base URL for all endpoints is