Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Xray uses Jira issues for implementing 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, taking into consideration Xray's custom fields.

The Xray REST API provides additional endpoints specifically made for dealing with test entities/fields and importing execution results from automated processes.

Authentication

The authentication is based on Jira's REST API authentication, so you can use  HTTP basic authentication using some user credentials.  It should also be possible to use other authentication methods such as cookie-based or OAuth (see more information here).

Version and URI

The Xray REST API has 2 versions: v1.0 and v2.0. New versions of the API are created whenever there are breaking changes that can have a big impact on current integrations.


The URIs for resources have the following structure:

https://<site-url>/rest/raven/<api-version>/api/<resource-name>

For example, http://yourserver/rest/raven/2.0/api/test/TEST-123/step


Note that the latest version of the Xray REST API is version 2.0. All endpoints from version 1.0 are available in version 2.0 unless they have been deprecated and removed intentionally.

You can also use "<latest>" as the API version. This will default to the latest version that is v2.0.


Check out the documentation for each version:


Children Display