Create Xray API Key

Owned by theCode4
Last updated: Nov 07, 2024
3 min read

To generate an Xray API Key, the Xray plugin 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:

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

    01_apps_manage_apps.png

  2. In the left sidebar, navigate to the ‘XRAY’ section, find ‘API Keys’, and then click 'Create API Key’.

    02_xray_api_keys_create_api_key.png

  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.

    03_user_generate.png

  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’.

     

    04_copy_client_ID_secret_close.png

  5. Following this, your newly created API key will appear in the list within the ‘API Keys’ section.

    05_api_list_created.png

  6. Now navigate to the Data Processor app within your Jira Cloud instance.

    06_apps_DP_xray.png

  7. In the left-side menu go to ‘Tokens’ ‘Xray API Token’.

    07_tokens_xray.png

  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.

    08_id_secret_validate.png

  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.

    09_confirmation_created_api.png

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 Data Processor for Jira - Multi BI Connector and Advanced Exporter app, we'd love to hear your thoughts. Help us improve by sharing your honest review of the Free, PRO or Xray 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 for any additional information or to request new features!