Page History
...
Requests made to Xray's GraphQL API must also be authenticated using the same end point endpoint for REST API authentication.
The authentication process uses a Client IdID 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 ID and Client Secret of your assigned API Key. You can then use any GraphQL or REST API end pointsAPI endpoints.
| Note | ||
|---|---|---|
| ||
Like Jira, Xray limits the rate for API requests to ensure that services are reliable and responsive to customers. Xray Standard has a 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. |
Xray GraphQL Schema Documentation
This is just an entry page that contains basic information about GraphQL API. You can access the complete schema documentation in the following URL:
| Info |
|---|
https://us.xray.cloud.getxray.app/ doc |
Xray GraphQL API Endpoint
| Info |
|---|
| Info | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
For deployments that use data residency, please use the url URL that matches your Xray region for more performant API. Available endpoints by zone
|
Discovering the Xray Cloud GraphQL API
...
It's helpful to picture a graph: dots connected by lines. The dots are nodes, the lines are edges. A connection defines a relationship between nodes.
| Anchor | ||||
|---|---|---|---|---|
|
Item
Item is is a generic term for an object. You can look up a an item directly, or you can access related items via a connection. If you specify a item that does not return a scalar, you must include subfields until all fields return scalars.
| Anchor | ||||
|---|---|---|---|---|
|
Resolver
Resolver is is a generic term for a query, mutation, or complex field. A complex field is any field in Xray Cloud GraphQL API that is not a scalar with with the exception of the fields field results.
Guides and other useful links
Here are some links that provide extra information and tools related with to GraphQL:
- GraphQL Documentation - here you can find general information about all aspects of GraphQL.
- Insomnia - a powerful HTTP client with native GraphQL support.