> For the complete documentation index, see [llms.txt](https://thecode4.gitbook.io/thecode4-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://thecode4.gitbook.io/thecode4-docs/user-guide/generate-access-tokens/create-xray-api-key.md).

# Create Xray API Key

To generate an **Xray API Key**, the [Xray plugin](https://marketplace.atlassian.com/apps/1211769/xray-test-management-for-jira?hosting=cloud\&tab=overview) must first be installed on your **Jira Cloud** instance.

Because of certain limitations, only **Jira** **administrators** have the capability to **manage API keys**, which are necessary for interacting with Xray through its REST API.

<https://docs.getxray.app/display/XRAYCLOUD/Global+Settings%3A+API+Keys>

***

### To add an Xray API Key, please follow these steps:<br>

1. While logged into your Jira Cloud instance, go to the '**Apps**' section and and then choose '**Manage your apps**'.<br>

   <figure><img src="https://3783386375-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWbAZwNh39hWp69xdDNc6%2Fuploads%2FnyUIt9arK9GzcGR2hGBK%2F01_apps_manage_apps.png?alt=media&amp;token=0a668af8-912d-4eec-b4b5-dab77af929d0" alt=""><figcaption></figcaption></figure>
2. In the left sidebar, navigate to the ‘**XRAY**’ section, find ‘**API Keys**’, and then click '**Create API Key**’.<br>

   <figure><img src="https://3783386375-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWbAZwNh39hWp69xdDNc6%2Fuploads%2FhXmds1cy2V7zVZW6VbxI%2F02_xray_api_keys_create_api_key.png?alt=media&amp;token=48315fcd-8bcf-459e-a538-53937bec8920" alt=""><figcaption></figcaption></figure>
3. In the pop-up dialog, begin by typing the **User’s name**, choose the correct one from the dropdown list, and then click on ‘**Generate**' button.<br>

   <figure><img src="https://3783386375-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWbAZwNh39hWp69xdDNc6%2Fuploads%2F08ZV6mNo0kO1C2iK0xW0%2F03_user_generate.png?alt=media&amp;token=b931ae93-d53c-4a70-b5c5-fcf47b793857" alt=""><figcaption></figcaption></figure>
4. In the next pop-up, a confirmation will show that the **API Key** has been successfully generated. Make sure to **copy** the ‘**Client Id**’ and ‘**Client Secret**’ to a secure location and click '**Close**’.<br>

   <figure><img src="https://3783386375-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWbAZwNh39hWp69xdDNc6%2Fuploads%2FjP9ybmFeTlzhcJ9Ak1YV%2F04_copy_client_ID_secret_close.png?alt=media&amp;token=10caafc4-dcc7-4bc5-a248-44fcf3ae4e1e" alt=""><figcaption></figcaption></figure>
5. Following this, your newly created API key will appear in the list within the ‘**API Keys**’ section.<br>

   <figure><img src="https://3783386375-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWbAZwNh39hWp69xdDNc6%2Fuploads%2FZAkniA5I4ZOmew8Lj7Ph%2F05_api_list_created.png?alt=media&amp;token=5ab89995-36ff-4814-b3bb-05e884c7fda4" alt=""><figcaption></figcaption></figure>
6. Now **navigate to the Data Processor app** within your **Jira Cloud** instance.<br>

   <figure><img src="https://3783386375-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWbAZwNh39hWp69xdDNc6%2Fuploads%2FqrQa0LNHejETlI43RH7M%2F06_apps_DP_xray.png?alt=media&amp;token=72cd7bbb-7a58-4eff-86f6-6f4449036844" alt=""><figcaption></figcaption></figure>
7. In the left-side menu go to ‘**Tokens**’ ➡️ ‘**Xray API Token**’.<br>

   <figure><img src="https://3783386375-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWbAZwNh39hWp69xdDNc6%2Fuploads%2FkxOlro5kWnzreRQZY7V7%2F07_tokens_xray.png?alt=media&amp;token=9710a3ac-477b-4c72-b97a-6d915a4705a9" alt=""><figcaption></figcaption></figure>
8. Paste the **Client ID** and **Client Secret** you previously copied into the appropriate fields. After filling these in, click on '**Validate & Save**' to finalize the process.\
   \
   Completing this step is essential for the authentication and preservation of your Xray API Key within the system.<br>

   <figure><img src="https://3783386375-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWbAZwNh39hWp69xdDNc6%2Fuploads%2F1m5XLPoPBRx4dYtOEaWl%2F08_id_secret_validate.png?alt=media&amp;token=ab3c5b53-35b3-443c-be9c-35466048016f" alt=""><figcaption></figcaption></figure>
9. After completing the process, a **warning sign** will appear, signifying that your **Xray API Key** has been **successfully stored** in the system. You're now ready to choose the Xray fields you wish to export.<br>

   <figure><img src="https://3783386375-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWbAZwNh39hWp69xdDNc6%2Fuploads%2FQAb84boT4X9MC0NmfkzO%2F09_confirmation_created_api.png?alt=media&amp;token=8991e136-020f-46d1-9012-d184fd0e8dd1" alt=""><figcaption></figcaption></figure>

***

**Every user** planning to export Xray fields must validate and save their **individual Xray API Key** and be **authorized** to use **Data Processor for Xray**. Without these steps, they will encounter a warning sign in the Data Sources section.

***

If you've had the chance to use the **BI Exporter for Jira** app, we'd love to hear your **thoughts**. Help us improve by sharing your honest review of the [Free](https://marketplace.atlassian.com/apps/1233034/data-processor-for-jira-multi-bi-connector-free?hosting=cloud\&tab=reviews), [PRO](https://marketplace.atlassian.com/apps/1233504/data-processor-for-jira-link-power-bi-looker-tableau-pro?hosting=cloud\&tab=reviews), [Xray](https://marketplace.atlassian.com/apps/1233855/data-processor-for-xray-power-bi-tableau-looker-connector?hosting=cloud\&tab=reviews) or [Projectrak](https://marketplace.atlassian.com/apps/1235379/bi-exporter-for-projectrak-power-bi-looker-tableau-csv?hosting=cloud\&tab=reviews) versions. Your feedback is crucial as we strive to improve and tailor our services to better meet your needs. 🤝

***

Still have questions? Feel free to [**reach out to us**](/thecode4-docs/support.md) for any additional information or to request new features!