---
title: "REST API"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44565892/REST%20API"
format: markdown
---
<span style="color: #000000">The Xray REST API provides endpoints specifically made for dealing with heavier or time-consuming operations.</span>

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](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44568019) global settings.

Thus, the first step for you is to obtain the token, <span style="color: #172b4d">which </span><span style="color: #172b4d">**expires after 24 hours**</span><span style="color: #172b4d">,</span> 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. Learn more [here](https://getxraydocs.atlassian.net/wiki/spaces/ProductKB/pages/46269458).

> ℹ️ The global REST API base URL for all endpoints is [https://xray.cloud.getxray.app/](https://xray.cloud.getxray.app/) .
> ℹ️ 
> ℹ️   
> ℹ️ For deployments that use [data residency](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565771), please use the URL that matches your Xray region for more performant API.

## Available endpoints by zone

| **Location** | **Region** | **Endpoint** |
| --- | --- | --- |
| Global | <span style="color: #172b4d">All Xray cloud across regions</span> | [https://xray.cloud.getxray.app/](https://xray.cloud.getxray.app/) |
| USA | <span style="color: #172b4d">Consists of USA region</span> | [https://us.xray.cloud.getxray.app/](https://us.xray.cloud.getxray.app/) |
| EU | <span style="color: #172b4d">Consists of Europe (Frankfurt) region</span> | [https://eu.xray.cloud.getxray.app/](https://eu.xray.cloud.getxray.app/) |
| Australia | <span style="color: #172b4d">Consists of Australia (Sydney) region</span> | [https://au.xray.cloud.getxray.app/](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.](https://developer.atlassian.com/cloud/jira/platform/rate-limiting)

<span style="color: #003366"> </span>

> Macro (children)


> ℹ️ ### 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 🙂