# How to Generate a Raw Data API key

To utilize the new API key-based authentication method, users must make the following adjustments to their API queries:

* **Parameter Name**: Replace the old password parameter with client_secret.
* **Parameter Value**: The value should be the newly generated **API key**.


:::success
For example, if the generated API key is API_KEY_123, the API call would be formatted as follows:

*http://server.name/w/api/rawdata.cgi?client_secret=API_KEY_123&sid=23*

:::


:::info
The API Key functionality is available on the [**Security tab**](/doc/security-VqVBj5TbfQ) of the [System Module](/doc/system-module-TNvU3yVfhr) for **Admin** and **System manager** privilege users. 

:::


 ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/48ddf0a7-308b-4fe9-b28a-e3ce1797eaa8/1133df60-97b1-489c-8ec6-d56584dcb928/image%20%281%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260909%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260909T143000Z&X-Amz-Expires=86400&X-Amz-Signature=118c12906e54294455b47e5dcf59c6b3e7b1b4c01e18415f6d3b11accf071af4&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =627x369")


### Generating API key


1. Click the **Generate API Key** button.

   
   
   ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/48ddf0a7-308b-4fe9-b28a-e3ce1797eaa8/b6cadd78-c3f0-4836-a555-a857d84ff160/EXP%20generate%20api%20key.PNG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260909%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260909T143000Z&X-Amz-Expires=86400&X-Amz-Signature=aebb26cf001390427b285bb325f5695270569b66bbf6891872e26f78f1c07e81&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =538x547")

   
   
   
2. The API Key will be created by the system.

   
   ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/48ddf0a7-308b-4fe9-b28a-e3ce1797eaa8/55837079-a541-43fe-a96a-33b869cfa922/api%20key%20generating.PNG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260909%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260909T143000Z&X-Amz-Expires=86400&X-Amz-Signature=2d8d9d248dccf33f49d54bc514b39042eeb5a55e7c4bd307266705b44c9bbcb1&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =448x293")

   
   
   ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/48ddf0a7-308b-4fe9-b28a-e3ce1797eaa8/8f9631a4-223a-4fbf-aa90-21e1bfc0584e/EXP%20generate%20api%20key2.PNG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260909%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260909T143000Z&X-Amz-Expires=86400&X-Amz-Signature=9a72311ba04bb82797a0954b86b82cf01b4d5c4d67672429ddfc7c928b2901a5&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =2836x348.5")

   
3. Click the **Copy to Clipboard** button to copy the API key.

   
   
:::warning
   **Warning:** Make sure you **copy the key (token) immediately**. The system does not store it, so you won't be able to see it later on.

   :::

   
:::warning
   Only one active API key can exist per system at any given time. Each newly created API Key will eliminate the currently existing one. 

   :::
4. Click Close.
5. *Active status*, *Creation date*, and *Created by* will be displayed in the Security tab's API Key section.

   
   ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/48ddf0a7-308b-4fe9-b28a-e3ce1797eaa8/75e5a099-e543-4fcd-8080-6887d429218e/apy%20key%20revoke.PNG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260909%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260909T143000Z&X-Amz-Expires=86400&X-Amz-Signature=e484e5ae5530ce177a967bd4fd69817275c00a0f9603fcab3a83144e4ec3d004&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =684x181")

   
   
6. Use the '**Revoke**' option under **Action** if needed.
7. Proceed with using the generated API Key secret as described on the [**How to Use the Raw Data API **](/doc/how-to-use-the-raw-data-api-FcH4XNrSPD)page.

   


---

### Revoking the API key



:::info
API key does not expire unless manually revoked.

:::


1. Press **Revoke** under **Action** in the API Key section of the Security tab.

   
   
   ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/48ddf0a7-308b-4fe9-b28a-e3ce1797eaa8/979b61c4-9299-415b-a0b3-6d3c00c95a12/apy%20key%20revoke_action.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260909%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260909T143000Z&X-Amz-Expires=86400&X-Amz-Signature=c7875c320056b78fe5ef93bb5febf36a874846fac7e9a92079653f8fe72f12f2&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =627x166")

   
   
   
   
2. A confirmation pop-up will appear—Press **Revoke** (or Cancel to quit the process).


:::warning
Warning: By this action, the system-wide API key will be deactivated. 



 ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/48ddf0a7-308b-4fe9-b28a-e3ce1797eaa8/b55c8a3a-18e5-4f65-8350-02af3eb00677/API%20KEY%20CONFIRMATION%20POPUP.PNG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260909%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260909T143000Z&X-Amz-Expires=86400&X-Amz-Signature=542a8b65df8d05efbe099ebc1f8d9a3a9eb0154d520bd705044deea4624889cc&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =1293x298")



:::

 ![](https://outline-production-attachments.s3-accelerate.amazonaws.com/uploads/48ddf0a7-308b-4fe9-b28a-e3ce1797eaa8/25e38c02-1947-450e-a45d-b9188a30a536/api%20key%20revoked.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIA4EOUDTOVUICLPZ4P%2F20260909%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260909T143000Z&X-Amz-Expires=86400&X-Amz-Signature=61e217d1afd3a169674334250f39549339c652e23083e194c5a1f751d544fdad&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject " =271x48")



:::info
See also: [**How to Use the Raw Data API**](/doc/how-to-use-the-raw-data-api-eCEEWjDVyN)**.**

:::

---

**Documents**

- [User Guide](https://kb.learningspace.elevatehealth.net/s/exp-hs/doc/user-guide-oarr3rXNmH)
- [FAQ](https://kb.learningspace.elevatehealth.net/s/exp-hs/doc/faq-YLwvsQzPg1)
- [Training Videos](https://kb.learningspace.elevatehealth.net/s/exp-hs/doc/training-videos-TEIl08kVIW)
- [Release Notes](https://kb.learningspace.elevatehealth.net/s/exp-hs/doc/release-notes-W7WkHQOdlB)
- [iPad support - Technical information](https://kb.learningspace.elevatehealth.net/s/exp-hs/doc/ipad-support-technical-information-CvKg62sptV)
- [Customer Aftercare One-Pager](https://kb.learningspace.elevatehealth.net/s/exp-hs/doc/customer-aftercare-one-pager-fm7WLpsnDM)